{"openapi":"3.1.0","info":{"title":"API Reference","version":"1.0.0"},"paths":{"/3.0/":{"get":{"operationId":"root_list","summary":"List API root resources","description":"Get links to all other resources available in the API.","tags":["Root"],"parameters":[{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/root_list_Response_200"}}}}},"security":[{"bearerToken":[]}]}},"/3.0/account-exports":{"get":{"operationId":"accountExports_list","summary":"List account exports","description":"Get a list of account exports for a given account.","tags":["accountExports"],"parameters":[{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"count","in":"query","description":"The number of records to return. Default value is 10. Maximum value is 1000","required":false,"schema":{"type":"integer","maximum":1000,"default":10}},{"name":"offset","in":"query","description":"Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0.","required":false,"schema":{"type":"integer","default":0}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/account-exports_list_Response_200"}}}}},"security":[{"bearerToken":[]}]},"post":{"operationId":"accountExports_create","summary":"Add export","description":"Create a new account export in your Mailchimp account.","tags":["accountExports"],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/account-exports_create_Response_200"}}}}},"requestBody":{"description":"Creates an account export with the given parameters.","content":{"application/json":{"schema":{"type":"object","properties":{"include_stages":{"type":"array","items":{"$ref":"#/components/schemas/30AccountExportsPostRequestBodyContentApplicationJsonSchemaIncludeStagesItems"},"description":"The stages of an account export to include."},"since_timestamp":{"type":"string","format":"date-time","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."}},"required":["include_stages"]}}}},"security":[{"bearerToken":[]}]}},"/3.0/account-exports/{export_id}":{"get":{"operationId":"accountExports_get","summary":"Get account export info","description":"Get information about a specific account export.","tags":["accountExports"],"parameters":[{"name":"export_id","in":"path","description":"The unique id for the account export.","required":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/account-exports_get_Response_200"}}}}},"security":[{"bearerToken":[]}]}},"/3.0/activity-feed":{"get":{"operationId":"activityFeed_list","summary":"List activity feed resources","description":"Get information about the activity feed endpoint's resources.","tags":["activityFeed"],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/30ActivityFeedGetResponsesContentApplicationJsonSchemaItems"}}}}}},"security":[{"bearerToken":[]}]}},"/3.0/activity-feed/chimp-chatter":{"get":{"operationId":"activityFeed_list-chimp-chatter","summary":"Get latest chimp chatter","description":"Return the Chimp Chatter for this account ordered by most recent.","tags":["activityFeed"],"parameters":[{"name":"count","in":"query","description":"The number of records to return. Default value is 10. Maximum value is 1000","required":false,"schema":{"type":"integer","maximum":1000,"default":10}},{"name":"offset","in":"query","description":"Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0.","required":false,"schema":{"type":"integer","default":0}}],"responses":{"200":{"description":"ChimpChatter Collection","content":{"application/json":{"schema":{"$ref":"#/components/schemas/activity-feed_list-chimp-chatter_Response_200"}}}}},"security":[{"bearerToken":[]}]}},"/3.0/audiences/{audience_id}/contacts":{"get":{"operationId":"audiences_getAudienceContactList","summary":"A collection of Audience Contacts","description":"Get a list of omni-channel contacts for a given audience.","tags":["audiences"],"parameters":[{"name":"audience_id","in":"path","description":"The unique ID for the audience.","required":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"count","in":"query","description":"The number of records to return. Default value is 10. Maximum value is 1000","required":false,"schema":{"type":"integer","maximum":1000,"default":10}},{"name":"cursor","in":"query","description":"Paginate through a collection of records by setting the `cursor` parameter to a `next_cursor` attribute returned by a previous request. Default value fetches the first \"page\" of results.","required":false,"schema":{"type":"string"}},{"name":"created_before","in":"query","description":"Restricts the response to contacts created at or before the specified time (inclusive). Uses ISO 8601 format: 2025-04-23T15:41:36+00:00.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"created_since","in":"query","description":"Restricts the response to contacts created after the specified time (exclusive). Uses ISO 8601 format: 2025-04-23T15:41:36+00:00.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"updated_before","in":"query","description":"Restricts the response to contacts updated at or before the specified time (inclusive). Uses ISO 8601 format: 2025-04-23T15:41:36+00:00.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"updated_since","in":"query","description":"Restricts the response to contacts updated after the specified time (exclusive). Uses ISO 8601 format: 2025-04-23T15:41:36+00:00.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"sort_field","in":"query","description":"Specifies the field to sort the returned contacts by.","required":false,"schema":{"$ref":"#/components/schemas/30AudiencesAudienceIdContactsGetParametersSortField"}},{"name":"sort_dir","in":"query","description":"Determines the order direction for sorted results.","required":false,"schema":{"$ref":"#/components/schemas/30AudiencesAudienceIdContactsGetParametersSortDir"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/audiences_getAudienceContactList_Response_200"}}}}},"security":[{"bearerToken":[]}]},"post":{"operationId":"audiences_createAudienceContact","summary":"Add Contact","description":"Create a new omni-channel contact for an audience.","tags":["audiences"],"parameters":[{"name":"audience_id","in":"path","description":"The unique ID for the audience.","required":true,"schema":{"type":"string"}},{"name":"merge_field_validation_mode","in":"query","description":"Defines how merge field validation is handled. When set to `ignore_required_checks`, the API does not raise an error if required merge fields are missing from the request. When set to `strict`, the API enforces validation and returns an error if any required merge field is not provided. If this setting is omitted, `strict` is applied by default.","required":false,"schema":{"$ref":"#/components/schemas/30AudiencesAudienceIdContactsPostParametersMergeFieldValidationMode"}},{"name":"data_mode","in":"query","description":"Indicates the data processing mode. In `historical` mode, contact data changes do not trigger automations or webhooks. In `live mode`, such changes do trigger them.","required":false,"schema":{"$ref":"#/components/schemas/30AudiencesAudienceIdContactsPostParametersDataMode"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AudiencesContact"}}}}},"requestBody":{"description":"An instance of a contact.","content":{"application/json":{"schema":{"type":"object","properties":{"email_channel":{"$ref":"#/components/schemas/30AudiencesAudienceIdContactsPostRequestBodyContentApplicationJsonSchemaEmailChannel"},"language":{"type":"string","description":"The contact's detected language."},"merge_fields":{"type":["object","null"],"additionalProperties":{"$ref":"#/components/schemas/30AudiencesAudienceIdContactsPostRequestBodyContentApplicationJsonSchemaMergeFields"},"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."},"sms_channel":{"$ref":"#/components/schemas/30AudiencesAudienceIdContactsPostRequestBodyContentApplicationJsonSchemaSmsChannel"},"tags":{"type":"array","items":{"$ref":"#/components/schemas/30AudiencesAudienceIdContactsPostRequestBodyContentApplicationJsonSchemaTagsItems"},"description":"An array of tags to add to the contact. Accepts tag name strings or objects with name and status. This operation is append-only; existing tags will be preserved, and only new tags from this array will be added."},"update_existing":{"type":"boolean","description":"If a contact already exists, update them instead of returning a conflict error. When `true` and a matching contact is found (by email or phone), the existing contact is updated with the provided channel data. Defaults to `false`."}}}}}},"security":[{"bearerToken":[]}]}},"/3.0/audiences/{audience_id}/contacts/{contact_id}":{"get":{"operationId":"audiences_getAudienceContact","summary":"Get a contact record","description":"Retrieve a specific omni-channel contact in an audience.","tags":["audiences"],"parameters":[{"name":"audience_id","in":"path","description":"The unique ID for the audience.","required":true,"schema":{"type":"string"}},{"name":"contact_id","in":"path","description":"A unique identifier for the contact, which can be a Mailchimp contact ID or a channel hash. A channel hash must follow the format email:[md5_hash] (where the hash is the MD5 of the lowercased email address) or sms:[sha256_hash] (where the hash is the SHA256 of the E.164-formatted phone number).","required":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AudiencesContact"}}}}},"security":[{"bearerToken":[]}]},"patch":{"operationId":"audiences_patchAudienceContact","summary":"Update Contact","description":"Update an existing omni-channel contact.","tags":["audiences"],"parameters":[{"name":"audience_id","in":"path","description":"The unique ID for the audience.","required":true,"schema":{"type":"string"}},{"name":"contact_id","in":"path","description":"The unique id for the contact.","required":true,"schema":{"type":"string"}},{"name":"merge_field_validation_mode","in":"query","description":"Defines how merge field validation is handled. When set to `ignore_required_checks`, the API does not raise an error if required merge fields are missing from the request. When set to `strict`, the API enforces validation and returns an error if any required merge field is not provided. If this setting is omitted, `strict` is applied by default.","required":false,"schema":{"$ref":"#/components/schemas/30AudiencesAudienceIdContactsContactIdPatchParametersMergeFieldValidationMode"}},{"name":"data_mode","in":"query","description":"Indicates the data processing mode. In `historical` mode, contact data changes do not trigger automations or webhooks. In `live mode`, such changes do trigger them.","required":false,"schema":{"$ref":"#/components/schemas/30AudiencesAudienceIdContactsContactIdPatchParametersDataMode"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AudiencesContact"}}}}},"requestBody":{"description":"An instance of a contact.","content":{"application/json":{"schema":{"type":"object","properties":{"email_channel":{"$ref":"#/components/schemas/30AudiencesAudienceIdContactsContactIdPatchRequestBodyContentApplicationJsonSchemaEmailChannel"},"language":{"type":"string","description":"The contact's detected language."},"merge_fields":{"type":["object","null"],"additionalProperties":{"$ref":"#/components/schemas/30AudiencesAudienceIdContactsContactIdPatchRequestBodyContentApplicationJsonSchemaMergeFields"},"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."},"sms_channel":{"$ref":"#/components/schemas/30AudiencesAudienceIdContactsContactIdPatchRequestBodyContentApplicationJsonSchemaSmsChannel"},"tags":{"type":"array","items":{"$ref":"#/components/schemas/30AudiencesAudienceIdContactsContactIdPatchRequestBodyContentApplicationJsonSchemaTagsItems"},"description":"An array of tags to add to the contact. Accepts tag name strings or objects with name and status. This operation is append-only; existing tags will be preserved, and only new tags from this array will be added."}}}}}},"security":[{"bearerToken":[]}]}},"/3.0/audiences/{audience_id}/contacts/{contact_id}/actions/archive":{"post":{"operationId":"audiences_postAudiencesContactsActionsArchive","summary":"Archive Contact","description":"Archives a Contact.","tags":["audiences"],"parameters":[{"name":"audience_id","in":"path","description":"The unique ID for the audience.","required":true,"schema":{"type":"string"}},{"name":"contact_id","in":"path","description":"The unique id for the contact.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Empty Response","content":{"application/json":{"schema":{"type":"object","properties":{}}}}}},"security":[{"bearerToken":[]}]}},"/3.0/audiences/{audience_id}/contacts/{contact_id}/actions/forget":{"post":{"operationId":"audiences_postAudiencesContactsActionsForget","summary":"Forget Contact","description":"Forgets a Contact.","tags":["audiences"],"parameters":[{"name":"audience_id","in":"path","description":"The unique ID for the audience.","required":true,"schema":{"type":"string"}},{"name":"contact_id","in":"path","description":"The unique id for the contact.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Empty Response","content":{"application/json":{"schema":{"type":"object","properties":{}}}}}},"security":[{"bearerToken":[]}]}},"/3.0/authorized-apps":{"get":{"operationId":"authorizedApps_list","summary":"List authorized apps","description":"Get a list of an account's registered, connected applications.","tags":["authorizedApps"],"parameters":[{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"count","in":"query","description":"The number of records to return. Default value is 10. Maximum value is 1000","required":false,"schema":{"type":"integer","maximum":1000,"default":10}},{"name":"offset","in":"query","description":"Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0.","required":false,"schema":{"type":"integer","default":0}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/authorized-apps_list_Response_200"}}}}},"security":[{"bearerToken":[]}]}},"/3.0/authorized-apps/{app_id}":{"get":{"operationId":"authorizedApps_get","summary":"Get authorized app info","description":"Get information about a specific authorized application.","tags":["authorizedApps"],"parameters":[{"name":"app_id","in":"path","description":"The unique id for the connected authorized application.","required":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/authorized-apps_get_Response_200"}}}}},"security":[{"bearerToken":[]}]}},"/3.0/automations":{"get":{"operationId":"automations_list","summary":"List automations","description":"Get a summary of an account's classic automations.","tags":["Automations"],"parameters":[{"name":"count","in":"query","description":"The number of records to return. Default value is 10. Maximum value is 1000","required":false,"schema":{"type":"integer","maximum":1000,"default":10}},{"name":"offset","in":"query","description":"Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0.","required":false,"schema":{"type":"integer","default":0}},{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"before_create_time","in":"query","description":"Restrict the response to automations created before this time. Uses the ISO 8601 time format: 2015-10-21T15:41:36+00:00.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"since_create_time","in":"query","description":"Restrict the response to automations created after this time. Uses the ISO 8601 time format: 2015-10-21T15:41:36+00:00.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"before_start_time","in":"query","description":"Restrict the response to automations started before this time. Uses the ISO 8601 time format: 2015-10-21T15:41:36+00:00.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"since_start_time","in":"query","description":"Restrict the response to automations started after this time. Uses the ISO 8601 time format: 2015-10-21T15:41:36+00:00.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"status","in":"query","description":"Restrict the results to automations with the specified status.","required":false,"schema":{"$ref":"#/components/schemas/30AutomationsGetParametersStatus"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/automations_list_Response_200"}}}}},"security":[{"bearerToken":[]}]},"post":{"operationId":"automations_create","summary":"Add automation","description":"Create a new classic automation in your Mailchimp account.","tags":["Automations"],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AutomationWorkflow"}}}}},"requestBody":{"description":"A summary of an individual Automation workflow's settings and content.","content":{"application/json":{"schema":{"type":"object","properties":{"recipients":{"$ref":"#/components/schemas/30AutomationsPostRequestBodyContentApplicationJsonSchemaRecipients","description":"List settings for the Automation."},"settings":{"$ref":"#/components/schemas/30AutomationsPostRequestBodyContentApplicationJsonSchemaSettings","description":"The settings for the Automation workflow."},"trigger_settings":{"$ref":"#/components/schemas/30AutomationsPostRequestBodyContentApplicationJsonSchemaTriggerSettings","description":"Trigger settings for the Automation."}},"required":["recipients","trigger_settings"]}}}},"security":[{"bearerToken":[]}]}},"/3.0/automations/{workflow_id}":{"get":{"operationId":"automations_get","summary":"Get automation info","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.","tags":["Automations"],"parameters":[{"name":"workflow_id","in":"path","description":"The unique id for the Automation workflow.","required":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AutomationWorkflow"}}}}},"security":[{"bearerToken":[]}]}},"/3.0/automations/{workflow_id}/actions/archive":{"post":{"operationId":"automations_create-action-archive","summary":"Archive automation","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.","tags":["Automations"],"parameters":[{"name":"workflow_id","in":"path","description":"The unique id for the Automation workflow.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Empty Response","content":{"application/json":{"schema":{"type":"object","properties":{}}}}}},"security":[{"bearerToken":[]}]}},"/3.0/automations/{workflow_id}/actions/pause-all-emails":{"post":{"operationId":"automations_create-action-pause-all-email","summary":"Pause automation emails","description":"Pause all emails in a specific classic automation workflow.","tags":["Automations"],"parameters":[{"name":"workflow_id","in":"path","description":"The unique id for the Automation workflow.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Empty Response","content":{"application/json":{"schema":{"type":"object","properties":{}}}}}},"security":[{"bearerToken":[]}]}},"/3.0/automations/{workflow_id}/actions/start-all-emails":{"post":{"operationId":"automations_create-action-start-all-email","summary":"Start automation emails","description":"Start all emails in a classic automation workflow.","tags":["Automations"],"parameters":[{"name":"workflow_id","in":"path","description":"The unique id for the Automation workflow.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Empty Response","content":{"application/json":{"schema":{"type":"object","properties":{}}}}}},"security":[{"bearerToken":[]}]}},"/3.0/automations/{workflow_id}/emails":{"get":{"operationId":"automations_list-emails","summary":"List automated emails","description":"Get a summary of the emails in a classic automation workflow.","tags":["Automations"],"parameters":[{"name":"workflow_id","in":"path","description":"The unique id for the Automation workflow.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/automations_list-emails_Response_200"}}}}},"security":[{"bearerToken":[]}]}},"/3.0/automations/{workflow_id}/emails/{workflow_email_id}":{"get":{"operationId":"automations_get-email","summary":"Get workflow email info","description":"Get information about an individual classic automation workflow email.","tags":["Automations"],"parameters":[{"name":"workflow_id","in":"path","description":"The unique id for the Automation workflow.","required":true,"schema":{"type":"string"}},{"name":"workflow_email_id","in":"path","description":"The unique id for the Automation workflow email.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AutomationWorkflowEmail"}}}}},"security":[{"bearerToken":[]}]},"patch":{"operationId":"automations_update-email","summary":"Update workflow email","description":"Update settings for a classic automation workflow email.  Only works with workflows of type: abandonedBrowse, abandonedCart, emailFollowup, or singleWelcome.","tags":["Automations"],"parameters":[{"name":"workflow_id","in":"path","description":"The unique id for the Automation workflow.","required":true,"schema":{"type":"string"}},{"name":"workflow_email_id","in":"path","description":"The unique id for the Automation workflow email.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AutomationWorkflowEmail"}}}}},"requestBody":{"description":"Update information about an individual Automation workflow email.","content":{"application/json":{"schema":{"type":"object","properties":{"delay":{"$ref":"#/components/schemas/30AutomationsWorkflowIdEmailsWorkflowEmailIdPatchRequestBodyContentApplicationJsonSchemaDelay","description":"The delay settings for an automation email."},"settings":{"$ref":"#/components/schemas/30AutomationsWorkflowIdEmailsWorkflowEmailIdPatchRequestBodyContentApplicationJsonSchemaSettings","description":"Settings for the campaign including the email subject, from name, and from email address."}}}}}},"security":[{"bearerToken":[]}]},"delete":{"operationId":"automations_delete-email","summary":"Delete workflow email","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.","tags":["Automations"],"parameters":[{"name":"workflow_id","in":"path","description":"The unique id for the Automation workflow.","required":true,"schema":{"type":"string"}},{"name":"workflow_email_id","in":"path","description":"The unique id for the Automation workflow email.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Empty Response","content":{"application/json":{"schema":{"type":"object","properties":{}}}}}},"security":[{"bearerToken":[]}]}},"/3.0/automations/{workflow_id}/emails/{workflow_email_id}/actions/pause":{"post":{"operationId":"automations_create-email-action-pause","summary":"Pause automated email","description":"Pause an automated email.","tags":["Automations"],"parameters":[{"name":"workflow_id","in":"path","description":"The unique id for the Automation workflow.","required":true,"schema":{"type":"string"}},{"name":"workflow_email_id","in":"path","description":"The unique id for the Automation workflow email.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Empty Response","content":{"application/json":{"schema":{"type":"object","properties":{}}}}}},"security":[{"bearerToken":[]}]}},"/3.0/automations/{workflow_id}/emails/{workflow_email_id}/actions/start":{"post":{"operationId":"automations_create-email-action-start","summary":"Start automated email","description":"Start an automated email.","tags":["Automations"],"parameters":[{"name":"workflow_id","in":"path","description":"The unique id for the Automation workflow.","required":true,"schema":{"type":"string"}},{"name":"workflow_email_id","in":"path","description":"The unique id for the Automation workflow email.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Empty Response","content":{"application/json":{"schema":{"type":"object","properties":{}}}}}},"security":[{"bearerToken":[]}]}},"/3.0/automations/{workflow_id}/emails/{workflow_email_id}/queue":{"get":{"operationId":"automations_list-email-queue","summary":"List automated email subscribers","description":"Get information about a classic automation email queue.","tags":["Automations"],"parameters":[{"name":"workflow_id","in":"path","description":"The unique id for the Automation workflow.","required":true,"schema":{"type":"string"}},{"name":"workflow_email_id","in":"path","description":"The unique id for the Automation workflow email.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/automations_list-email-queue_Response_200"}}}}},"security":[{"bearerToken":[]}]},"post":{"operationId":"automations_create-email-queue","summary":"Add subscriber to workflow email","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.","tags":["Automations"],"parameters":[{"name":"workflow_id","in":"path","description":"The unique id for the Automation workflow.","required":true,"schema":{"type":"string"}},{"name":"workflow_email_id","in":"path","description":"The unique id for the Automation workflow email.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriberInAutomationQueue"}}}}},"requestBody":{"description":"Information about subscribers in an Automation email queue.","content":{"application/json":{"schema":{"type":"object","properties":{"email_address":{"type":"string","description":"The list member's email address."}},"required":["email_address"]}}}},"security":[{"bearerToken":[]}]}},"/3.0/automations/{workflow_id}/emails/{workflow_email_id}/queue/{subscriber_hash}":{"get":{"operationId":"automations_get-email-queue","summary":"Get automated email subscriber","description":"Get information about a specific subscriber in a classic automation email queue.","tags":["Automations"],"parameters":[{"name":"workflow_id","in":"path","description":"The unique id for the Automation workflow.","required":true,"schema":{"type":"string"}},{"name":"workflow_email_id","in":"path","description":"The unique id for the Automation workflow email.","required":true,"schema":{"type":"string"}},{"name":"subscriber_hash","in":"path","description":"The MD5 hash of the lowercase version of the list member's email address.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriberInAutomationQueue"}}}}},"security":[{"bearerToken":[]}]}},"/3.0/automations/{workflow_id}/removed-subscribers":{"get":{"operationId":"automations_list-removed-subscribers","summary":"List subscribers removed from workflow","description":"Get information about subscribers who were removed from a classic automation workflow.","tags":["Automations"],"parameters":[{"name":"workflow_id","in":"path","description":"The unique id for the Automation workflow.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/automations_list-removed-subscribers_Response_200"}}}}},"security":[{"bearerToken":[]}]},"post":{"operationId":"automations_create-removed-subscriber","summary":"Remove subscriber from workflow","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.","tags":["Automations"],"parameters":[{"name":"workflow_id","in":"path","description":"The unique id for the Automation workflow.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriberRemovedFromAutomationWorkflow"}}}}},"requestBody":{"description":"Information about subscribers in an Automation email queue.","content":{"application/json":{"schema":{"type":"object","properties":{"email_address":{"type":"string","description":"The list member's email address."}},"required":["email_address"]}}}},"security":[{"bearerToken":[]}]}},"/3.0/automations/{workflow_id}/removed-subscribers/{subscriber_hash}":{"get":{"operationId":"automations_get-removed-subscriber","summary":"Get subscriber removed from workflow","description":"Get information about a specific subscriber who was removed from a classic automation workflow.","tags":["Automations"],"parameters":[{"name":"workflow_id","in":"path","description":"The unique id for the Automation workflow.","required":true,"schema":{"type":"string"}},{"name":"subscriber_hash","in":"path","description":"The MD5 hash of the lowercase version of the list member's email address.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriberRemovedFromAutomationWorkflow"}}}}},"security":[{"bearerToken":[]}]}},"/3.0/batch-webhooks":{"get":{"operationId":"batchWebhooks_list","summary":"List batch webhooks","description":"Get all webhooks that have been configured for batches.","tags":["batchWebhooks"],"parameters":[{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"count","in":"query","description":"The number of records to return. Default value is 10. Maximum value is 1000","required":false,"schema":{"type":"integer","maximum":1000,"default":10}},{"name":"offset","in":"query","description":"Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0.","required":false,"schema":{"type":"integer","default":0}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/batch-webhooks_list_Response_200"}}}}},"security":[{"bearerToken":[]}]},"post":{"operationId":"batchWebhooks_create","summary":"Add batch webhook","description":"Configure a webhook that will fire whenever any batch request completes processing.  You may only have a maximum of 20 batch webhooks.","tags":["batchWebhooks"],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/batch-webhooks_create_Response_200"}}}}},"requestBody":{"description":"Add a new Batch Webook.","content":{"application/json":{"schema":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether the webhook receives requests or not."},"url":{"type":"string","description":"A valid URL for the Webhook."}},"required":["url"]}}}},"security":[{"bearerToken":[]}]}},"/3.0/batch-webhooks/{batch_webhook_id}":{"get":{"operationId":"batchWebhooks_get","summary":"Get batch webhook info","description":"Get information about a specific batch webhook.","tags":["batchWebhooks"],"parameters":[{"name":"batch_webhook_id","in":"path","description":"The unique id for the batch webhook.","required":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchWebhook"}}}}},"security":[{"bearerToken":[]}]},"delete":{"operationId":"batchWebhooks_delete","summary":"Delete batch webhook","description":"Remove a batch webhook. Webhooks will no longer be sent to the given URL.","tags":["batchWebhooks"],"parameters":[{"name":"batch_webhook_id","in":"path","description":"The unique id for the batch webhook.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Empty Response","content":{"application/json":{"schema":{"type":"object","properties":{}}}}}},"security":[{"bearerToken":[]}]},"patch":{"operationId":"batchWebhooks_update","summary":"Update batch webhook","description":"Update a webhook that will fire whenever any batch request completes processing.","tags":["batchWebhooks"],"parameters":[{"name":"batch_webhook_id","in":"path","description":"The unique id for the batch webhook.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchWebhook"}}}}},"requestBody":{"description":"Update an existing Batch Webook.","content":{"application/json":{"schema":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether the webhook receives requests or not."},"url":{"type":"string","description":"A valid URL for the Webhook."}}}}}},"security":[{"bearerToken":[]}]}},"/3.0/batches":{"get":{"operationId":"batches_list","summary":"List batch requests","description":"Get a summary of batch requests that have been made.","tags":["Batches"],"parameters":[{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"count","in":"query","description":"The number of records to return. Default value is 10. Maximum value is 1000","required":false,"schema":{"type":"integer","maximum":1000,"default":10}},{"name":"offset","in":"query","description":"Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0.","required":false,"schema":{"type":"integer","default":0}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/batches_list_Response_200"}}}}},"security":[{"bearerToken":[]}]},"post":{"operationId":"batches_create","summary":"Start batch operation","description":"Begin processing a batch operations request.","tags":["Batches"],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Batch"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"operations":{"type":"array","items":{"$ref":"#/components/schemas/30BatchesPostRequestBodyContentApplicationJsonSchemaOperationsItems"},"description":"An array of objects that describes operations to perform."}},"required":["operations"]}}}},"security":[{"bearerToken":[]}]}},"/3.0/batches/{batch_id}":{"get":{"operationId":"batches_get","summary":"Get batch operation status","description":"Get the status of a batch request.","tags":["Batches"],"parameters":[{"name":"batch_id","in":"path","description":"The unique id for the batch operation.","required":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Batch"}}}}},"security":[{"bearerToken":[]}]},"delete":{"operationId":"batches_delete","summary":"Delete batch request","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.","tags":["Batches"],"parameters":[{"name":"batch_id","in":"path","description":"The unique id for the batch operation.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Empty Response","content":{"application/json":{"schema":{"type":"object","properties":{}}}}}},"security":[{"bearerToken":[]}]}},"/3.0/campaign-folders":{"get":{"operationId":"campaignFolders_list","summary":"List campaign folders","description":"Get all folders used to organize campaigns.","tags":["campaignFolders"],"parameters":[{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"count","in":"query","description":"The number of records to return. Default value is 10. Maximum value is 1000","required":false,"schema":{"type":"integer","maximum":1000,"default":10}},{"name":"offset","in":"query","description":"Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0.","required":false,"schema":{"type":"integer","default":0}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignFolders"}}}}},"security":[{"bearerToken":[]}]},"post":{"operationId":"campaignFolders_create","summary":"Add campaign folder","description":"Create a new campaign folder.","tags":["campaignFolders"],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignFolders"}}}}},"requestBody":{"description":"A folder used to organize campaigns.","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Name to associate with the folder."}},"required":["name"]}}}},"security":[{"bearerToken":[]}]}},"/3.0/campaign-folders/{folder_id}":{"get":{"operationId":"campaignFolders_get","summary":"Get campaign folder","description":"Get information about a specific folder used to organize campaigns.","tags":["campaignFolders"],"parameters":[{"name":"folder_id","in":"path","description":"The unique id for the campaign folder.","required":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/campaign-folders_get_Response_200"}}}}},"security":[{"bearerToken":[]}]},"delete":{"operationId":"campaignFolders_delete","summary":"Delete campaign folder","description":"Delete a specific campaign folder, and mark all the campaigns in the folder as 'unfiled'.","tags":["campaignFolders"],"parameters":[{"name":"folder_id","in":"path","description":"The unique id for the campaign folder.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Empty Response","content":{"application/json":{"schema":{"type":"object","properties":{}}}}}},"security":[{"bearerToken":[]}]},"patch":{"operationId":"campaignFolders_update","summary":"Update campaign folder","description":"Update a specific folder used to organize campaigns.","tags":["campaignFolders"],"parameters":[{"name":"folder_id","in":"path","description":"The unique id for the campaign folder.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/campaign-folders_update_Response_200"}}}}},"requestBody":{"description":"A folder used to organize campaigns.","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Name to associate with the folder."}},"required":["name"]}}}},"security":[{"bearerToken":[]}]}},"/3.0/campaigns":{"get":{"operationId":"campaigns_list","summary":"List campaigns","description":"Get all campaigns in an account.","tags":["Campaigns"],"parameters":[{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"count","in":"query","description":"The number of records to return. Default value is 10. Maximum value is 1000","required":false,"schema":{"type":"integer","maximum":1000,"default":10}},{"name":"offset","in":"query","description":"Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0.","required":false,"schema":{"type":"integer","default":0}},{"name":"type","in":"query","description":"The campaign type.","required":false,"schema":{"$ref":"#/components/schemas/30CampaignsGetParametersType"}},{"name":"status","in":"query","description":"The status of the campaign.","required":false,"schema":{"$ref":"#/components/schemas/30CampaignsGetParametersStatus"}},{"name":"before_send_time","in":"query","description":"Restrict the response to campaigns sent before the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"since_send_time","in":"query","description":"Restrict the response to campaigns sent after the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"before_create_time","in":"query","description":"Restrict the response to campaigns created before the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"since_create_time","in":"query","description":"Restrict the response to campaigns created after the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"list_id","in":"query","description":"The unique id for the list.","required":false,"schema":{"type":"string"}},{"name":"folder_id","in":"query","description":"The unique folder id.","required":false,"schema":{"type":"string"}},{"name":"member_id","in":"query","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.","required":false,"schema":{"type":"string"}},{"name":"sort_field","in":"query","description":"Returns files sorted by the specified field.","required":false,"schema":{"$ref":"#/components/schemas/30CampaignsGetParametersSortField"}},{"name":"sort_dir","in":"query","description":"Determines the order direction for sorted results.","required":false,"schema":{"$ref":"#/components/schemas/30CampaignsGetParametersSortDir"}},{"name":"include_resend_shortcut_eligibility","in":"query","description":"Return the `resend_shortcut_eligibility` field in the response, which tells you if the campaign is eligible for the various Campaign Resend Shortcuts offered.","required":false,"schema":{"type":"boolean"}},{"name":"include_resend_shortcut_usage","in":"query","description":"Return the `resend_shortcut_usage` field in the response.  This includes information about campaigns related by a shortcut.","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/campaigns_list_Response_200"}}}}},"security":[{"bearerToken":[]}]},"post":{"operationId":"campaigns_create","summary":"Add campaign","description":"Create a new Mailchimp campaign.","tags":["Campaigns"],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Campaign"}}}}},"requestBody":{"description":"A summary of an individual campaign's settings and content.","content":{"application/json":{"schema":{"type":"object","properties":{"content_type":{"$ref":"#/components/schemas/30CampaignsPostRequestBodyContentApplicationJsonSchemaContentType","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."},"recipients":{"$ref":"#/components/schemas/30CampaignsPostRequestBodyContentApplicationJsonSchemaRecipients","description":"List settings for the campaign."},"rss_opts":{"$ref":"#/components/schemas/30CampaignsPostRequestBodyContentApplicationJsonSchemaRssOpts","description":"[RSS](https://mailchimp.com/help/share-your-blog-posts-with-mailchimp/) options, specific to an RSS campaign."},"settings":{"$ref":"#/components/schemas/30CampaignsPostRequestBodyContentApplicationJsonSchemaSettings","description":"The settings for your campaign, including subject, from name, reply-to address, and more."},"social_card":{"$ref":"#/components/schemas/30CampaignsPostRequestBodyContentApplicationJsonSchemaSocialCard","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/)."},"tracking":{"$ref":"#/components/schemas/CampaignTrackingOptions"},"type":{"$ref":"#/components/schemas/30CampaignsPostRequestBodyContentApplicationJsonSchemaType","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."},"variate_settings":{"$ref":"#/components/schemas/30CampaignsPostRequestBodyContentApplicationJsonSchemaVariateSettings","description":"The settings specific to A/B test campaigns."}},"required":["type"]}}}},"security":[{"bearerToken":[]}]}},"/3.0/campaigns/{campaign_id}":{"get":{"operationId":"campaigns_get","summary":"Get campaign info","description":"Get information about a specific campaign.","tags":["Campaigns"],"parameters":[{"name":"campaign_id","in":"path","description":"The unique id for the campaign.","required":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"include_resend_shortcut_eligibility","in":"query","description":"Return the `resend_shortcut_eligibility` field in the response, which tells you if the campaign is eligible for the various Campaign Resend Shortcuts offered.","required":false,"schema":{"type":"boolean"}},{"name":"include_resend_shortcut_usage","in":"query","description":"Return the `resend_shortcut_usage` field in the response.  This includes information about campaigns related by a shortcut.","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Campaign"}}}}},"security":[{"bearerToken":[]}]},"patch":{"operationId":"campaigns_update","summary":"Update campaign settings","description":"Update some or all of the settings for a specific campaign.","tags":["Campaigns"],"parameters":[{"name":"campaign_id","in":"path","description":"The unique id for the campaign.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Campaign"}}}}},"requestBody":{"description":"A summary of an individual campaign's settings and content.","content":{"application/json":{"schema":{"type":"object","properties":{"recipients":{"$ref":"#/components/schemas/30CampaignsCampaignIdPatchRequestBodyContentApplicationJsonSchemaRecipients","description":"List settings for the campaign."},"rss_opts":{"$ref":"#/components/schemas/30CampaignsCampaignIdPatchRequestBodyContentApplicationJsonSchemaRssOpts","description":"[RSS](https://mailchimp.com/help/share-your-blog-posts-with-mailchimp/) options for a campaign."},"settings":{"$ref":"#/components/schemas/30CampaignsCampaignIdPatchRequestBodyContentApplicationJsonSchemaSettings","description":"The settings for your campaign, including subject, from name, reply-to address, and more."},"social_card":{"$ref":"#/components/schemas/30CampaignsCampaignIdPatchRequestBodyContentApplicationJsonSchemaSocialCard","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/)."},"tracking":{"$ref":"#/components/schemas/CampaignTrackingOptions"},"variate_settings":{"$ref":"#/components/schemas/30CampaignsCampaignIdPatchRequestBodyContentApplicationJsonSchemaVariateSettings","description":"The settings specific to A/B test campaigns."}}}}}},"security":[{"bearerToken":[]}]},"delete":{"operationId":"campaigns_delete","summary":"Delete campaign","description":"Remove a campaign from your Mailchimp account.","tags":["Campaigns"],"parameters":[{"name":"campaign_id","in":"path","description":"The unique id for the campaign.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Empty Response","content":{"application/json":{"schema":{"type":"object","properties":{}}}}}},"security":[{"bearerToken":[]}]}},"/3.0/campaigns/{campaign_id}/actions/cancel-send":{"post":{"operationId":"campaigns_create-action-cancel-send","summary":"Cancel campaign","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.","tags":["Campaigns"],"parameters":[{"name":"campaign_id","in":"path","description":"The unique id for the campaign.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Empty Response","content":{"application/json":{"schema":{"type":"object","properties":{}}}}}},"security":[{"bearerToken":[]}]}},"/3.0/campaigns/{campaign_id}/actions/create-resend":{"post":{"operationId":"campaigns_create-action-create-resend","summary":"Resend campaign","description":"Remove the guesswork for resending a campaign to certain segments. You can use this endpoint as a shortcut to replicate a campaign and resend it to common segments, such as those who didn't open the campaign, or any new subscribers since it was sent.","tags":["Campaigns"],"parameters":[{"name":"campaign_id","in":"path","description":"The unique id for the campaign.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Campaign"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"shortcut_type":{"$ref":"#/components/schemas/30CampaignsCampaignIdActionsCreateResendPostRequestBodyContentApplicationJsonSchemaShortcutType","description":"Which campaign resend shortcut to use. Default is `to_non_openers`."}}}}}},"security":[{"bearerToken":[]}]}},"/3.0/campaigns/{campaign_id}/actions/pause":{"post":{"operationId":"campaigns_create-action-pause","summary":"Pause rss campaign","description":"Pause an RSS-Driven campaign.","tags":["Campaigns"],"parameters":[{"name":"campaign_id","in":"path","description":"The unique id for the campaign.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Empty Response","content":{"application/json":{"schema":{"type":"object","properties":{}}}}}},"security":[{"bearerToken":[]}]}},"/3.0/campaigns/{campaign_id}/actions/replicate":{"post":{"operationId":"campaigns_create-action-replicate","summary":"Replicate campaign","description":"Replicate a campaign in saved or send status.","tags":["Campaigns"],"parameters":[{"name":"campaign_id","in":"path","description":"The unique id for the campaign.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Campaign"}}}}},"security":[{"bearerToken":[]}]}},"/3.0/campaigns/{campaign_id}/actions/resume":{"post":{"operationId":"campaigns_create-action-resume","summary":"Resume rss campaign","description":"Resume an RSS-Driven campaign.","tags":["Campaigns"],"parameters":[{"name":"campaign_id","in":"path","description":"The unique id for the campaign.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Empty Response","content":{"application/json":{"schema":{"type":"object","properties":{}}}}}},"security":[{"bearerToken":[]}]}},"/3.0/campaigns/{campaign_id}/actions/schedule":{"post":{"operationId":"campaigns_create-action-schedule","summary":"Schedule campaign","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.","tags":["Campaigns"],"parameters":[{"name":"campaign_id","in":"path","description":"The unique id for the campaign.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Empty Response","content":{"application/json":{"schema":{"type":"object","properties":{}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"batch_delivery":{"$ref":"#/components/schemas/30CampaignsCampaignIdActionsSchedulePostRequestBodyContentApplicationJsonSchemaBatchDelivery","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/)."},"schedule_time":{"type":"string","format":"date-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)."},"timewarp":{"type":"boolean","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/)."}},"required":["schedule_time"]}}}},"security":[{"bearerToken":[]}]}},"/3.0/campaigns/{campaign_id}/actions/send":{"post":{"operationId":"campaigns_create-action-send","summary":"Send campaign","description":"Send a Mailchimp campaign. For RSS Campaigns, the campaign will send according to its schedule. All other campaigns will send immediately.","tags":["Campaigns"],"parameters":[{"name":"campaign_id","in":"path","description":"The unique id for the campaign.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Empty Response","content":{"application/json":{"schema":{"type":"object","properties":{}}}}}},"security":[{"bearerToken":[]}]}},"/3.0/campaigns/{campaign_id}/actions/test":{"post":{"operationId":"campaigns_create-action-test","summary":"Send test email","description":"Send a test email.","tags":["Campaigns"],"parameters":[{"name":"campaign_id","in":"path","description":"The unique id for the campaign.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Empty Response","content":{"application/json":{"schema":{"type":"object","properties":{}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"send_type":{"$ref":"#/components/schemas/30CampaignsCampaignIdActionsTestPostRequestBodyContentApplicationJsonSchemaSendType","description":"Choose the type of test email to send."},"test_emails":{"type":"array","items":{"type":"string"},"description":"An array of email addresses to send the test email to."}},"required":["send_type","test_emails"]}}}},"security":[{"bearerToken":[]}]}},"/3.0/campaigns/{campaign_id}/actions/unschedule":{"post":{"operationId":"campaigns_create-action-unschedule","summary":"Unschedule campaign","description":"Unschedule a scheduled campaign that hasn't started sending.","tags":["Campaigns"],"parameters":[{"name":"campaign_id","in":"path","description":"The unique id for the campaign.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Empty Response","content":{"application/json":{"schema":{"type":"object","properties":{}}}}}},"security":[{"bearerToken":[]}]}},"/3.0/campaigns/{campaign_id}/content":{"get":{"operationId":"campaigns_get-content","summary":"Get campaign content","description":"Get the the HTML and plain-text content for a campaign.","tags":["Campaigns"],"parameters":[{"name":"campaign_id","in":"path","description":"The unique id for the campaign.","required":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignContent"}}}}},"security":[{"bearerToken":[]}]},"put":{"operationId":"campaigns_upsert-content","summary":"Set campaign content","description":"Set the content for a campaign.","tags":["Campaigns"],"parameters":[{"name":"campaign_id","in":"path","description":"The unique id for the campaign.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignContent"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignContent"}}}},"security":[{"bearerToken":[]}]}},"/3.0/campaigns/{campaign_id}/send-checklist":{"get":{"operationId":"campaigns_list-send-checklist","summary":"Get campaign send checklist","description":"Review the send checklist for a campaign, and resolve any issues before sending.","tags":["Campaigns"],"parameters":[{"name":"campaign_id","in":"path","description":"The unique id for the campaign.","required":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/campaigns_list-send-checklist_Response_200"}}}}},"security":[{"bearerToken":[]}]}},"/3.0/campaigns/{campaign_id}/feedback":{"get":{"operationId":"campaigns_list-feedback","summary":"List campaign feedback","description":"Get team feedback while you're working together on a Mailchimp campaign.","tags":["Campaigns"],"parameters":[{"name":"campaign_id","in":"path","description":"The unique id for the campaign.","required":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/campaigns_list-feedback_Response_200"}}}}},"security":[{"bearerToken":[]}]},"post":{"operationId":"campaigns_create-feedback","summary":"Add campaign feedback","description":"Add feedback on a specific campaign.","tags":["Campaigns"],"parameters":[{"name":"campaign_id","in":"path","description":"The unique id for the campaign.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/campaigns_create-feedback_Response_200"}}}}},"requestBody":{"description":"A specific feedback message from a specific campaign.","content":{"application/json":{"schema":{"type":"object","properties":{"block_id":{"type":"integer","description":"The block id for the editable block that the feedback addresses."},"is_complete":{"type":"boolean","description":"The status of feedback."},"message":{"type":"string","description":"The content of the feedback."}},"required":["message"]}}}},"security":[{"bearerToken":[]}]}},"/3.0/campaigns/{campaign_id}/feedback/{feedback_id}":{"get":{"operationId":"campaigns_get-feedback","summary":"Get campaign feedback message","description":"Get a specific feedback message from a campaign.","tags":["Campaigns"],"parameters":[{"name":"campaign_id","in":"path","description":"The unique id for the campaign.","required":true,"schema":{"type":"string"}},{"name":"feedback_id","in":"path","description":"The unique id for the feedback message.","required":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignFeedback"}}}}},"security":[{"bearerToken":[]}]},"patch":{"operationId":"campaigns_update-feedback","summary":"Update campaign feedback message","description":"Update a specific feedback message for a campaign.","tags":["Campaigns"],"parameters":[{"name":"campaign_id","in":"path","description":"The unique id for the campaign.","required":true,"schema":{"type":"string"}},{"name":"feedback_id","in":"path","description":"The unique id for the feedback message.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignFeedback"}}}}},"requestBody":{"description":"A specific feedback message from a specific campaign.","content":{"application/json":{"schema":{"type":"object","properties":{"block_id":{"type":"integer","description":"The block id for the editable block that the feedback addresses."},"is_complete":{"type":"boolean","description":"The status of feedback."},"message":{"type":"string","description":"The content of the feedback."}}}}}},"security":[{"bearerToken":[]}]},"delete":{"operationId":"campaigns_delete-feedback","summary":"Delete campaign feedback message","description":"Remove a specific feedback message for a campaign.","tags":["Campaigns"],"parameters":[{"name":"campaign_id","in":"path","description":"The unique id for the campaign.","required":true,"schema":{"type":"string"}},{"name":"feedback_id","in":"path","description":"The unique id for the feedback message.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Empty Response","content":{"application/json":{"schema":{"type":"object","properties":{}}}}}},"security":[{"bearerToken":[]}]}},"/3.0/connected-sites":{"get":{"operationId":"connectedSites_list","summary":"List connected sites","description":"Get all connected sites in an account.","tags":["connectedSites"],"parameters":[{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"count","in":"query","description":"The number of records to return. Default value is 10. Maximum value is 1000","required":false,"schema":{"type":"integer","maximum":1000,"default":10}},{"name":"offset","in":"query","description":"Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0.","required":false,"schema":{"type":"integer","default":0}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/connected-sites_list_Response_200"}}}}},"security":[{"bearerToken":[]}]},"post":{"operationId":"connectedSites_create","summary":"Add connected site","description":"Create a new Mailchimp connected site.","tags":["connectedSites"],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectedSite"}}}}},"requestBody":{"description":"Information about a specific connected site.","content":{"application/json":{"schema":{"type":"object","properties":{"domain":{"type":"string","description":"The connected site domain."},"foreign_id":{"type":"string","description":"The unique identifier for the site."}},"required":["domain","foreign_id"]}}}},"security":[{"bearerToken":[]}]}},"/3.0/connected-sites/{connected_site_id}":{"get":{"operationId":"connectedSites_get","summary":"Get connected site","description":"Get information about a specific connected site.","tags":["connectedSites"],"parameters":[{"name":"connected_site_id","in":"path","description":"The unique identifier for the site.","required":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectedSite"}}}}},"security":[{"bearerToken":[]}]},"delete":{"operationId":"connectedSites_delete","summary":"Delete connected site","description":"Remove a connected site from your Mailchimp account.","tags":["connectedSites"],"parameters":[{"name":"connected_site_id","in":"path","description":"The unique identifier for the site.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Empty Response","content":{"application/json":{"schema":{"type":"object","properties":{}}}}}},"security":[{"bearerToken":[]}]}},"/3.0/connected-sites/{connected_site_id}/actions/verify-script-installation":{"post":{"operationId":"connectedSites_create-action-verify-script-installation","summary":"Verify connected site script","description":"Verify that the connected sites script has been installed, either via the script URL or fragment.","tags":["connectedSites"],"parameters":[{"name":"connected_site_id","in":"path","description":"The unique identifier for the site.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Empty Response","content":{"application/json":{"schema":{"type":"object","properties":{}}}}}},"security":[{"bearerToken":[]}]}},"/3.0/conversations":{"get":{"operationId":"conversations_list","summary":"List conversations","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.","tags":["Conversations"],"parameters":[{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"count","in":"query","description":"The number of records to return. Default value is 10. Maximum value is 1000","required":false,"schema":{"type":"integer","maximum":1000,"default":10}},{"name":"offset","in":"query","description":"Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0.","required":false,"schema":{"type":"integer","default":0}},{"name":"has_unread_messages","in":"query","description":"Whether the conversation has any unread messages.","required":false,"schema":{"$ref":"#/components/schemas/30ConversationsGetParametersHasUnreadMessages"}},{"name":"list_id","in":"query","description":"The unique id for the list.","required":false,"schema":{"type":"string"}},{"name":"campaign_id","in":"query","description":"The unique id for the campaign.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/conversations_list_Response_200"}}}}},"security":[{"bearerToken":[]}]}},"/3.0/conversations/{conversation_id}":{"get":{"operationId":"conversations_get","summary":"Get conversation","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.","tags":["Conversations"],"parameters":[{"name":"conversation_id","in":"path","description":"The unique id for the conversation.","required":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Conversation"}}}}},"security":[{"bearerToken":[]}]}},"/3.0/conversations/{conversation_id}/messages":{"get":{"operationId":"conversations_list-messages","summary":"List messages","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.","tags":["Conversations"],"parameters":[{"name":"conversation_id","in":"path","description":"The unique id for the conversation.","required":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"is_read","in":"query","description":"Whether a conversation message has been marked as read.","required":false,"schema":{"$ref":"#/components/schemas/30ConversationsConversationIdMessagesGetParametersIsRead"}},{"name":"before_timestamp","in":"query","description":"Restrict the response to messages created before the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"since_timestamp","in":"query","description":"Restrict the response to messages created after the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.","required":false,"schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/conversations_list-messages_Response_200"}}}}},"security":[{"bearerToken":[]}]}},"/3.0/conversations/{conversation_id}/messages/{message_id}":{"get":{"operationId":"conversations_get-message","summary":"Get message","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.","tags":["Conversations"],"parameters":[{"name":"conversation_id","in":"path","description":"The unique id for the conversation.","required":true,"schema":{"type":"string"}},{"name":"message_id","in":"path","description":"The unique id for the conversation message.","required":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConversationMessage"}}}}},"security":[{"bearerToken":[]}]}},"/3.0/customer-journeys/journeys/{journey_id}/steps/{step_id}/actions/trigger":{"post":{"operationId":"customerJourneys_create-journey-step-action-trigger","summary":"Automation flows API trigger for a contact","description":"A step trigger in an Automation flow. To use it, create a starting point or step from the Automation flow 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.","tags":["customerJourneys"],"parameters":[{"name":"journey_id","in":"path","description":"The id for the flow.","required":true,"schema":{"type":"integer"}},{"name":"step_id","in":"path","description":"The id for the Step.","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"Empty Response","content":{"application/json":{"schema":{"type":"object","properties":{}}}}}},"requestBody":{"description":"Information about subscribers in an Automation flow's audience.","content":{"application/json":{"schema":{"type":"object","properties":{"email_address":{"type":"string","description":"The list member's email address."}},"required":["email_address"]}}}},"security":[{"bearerToken":[]}]}},"/3.0/ecommerce":{"get":{"operationId":"ecommerce_list","summary":"List e-commerce api resources","description":"Get information about the e-commerce endpoint's resources.","tags":["Ecommerce"],"responses":{"200":{"description":"Ecommerce Resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ecommerce_list_Response_200"}}}}},"security":[{"bearerToken":[]}]}},"/3.0/ecommerce/orders":{"get":{"operationId":"ecommerce_list-orders","summary":"List account orders","description":"Get information about an account's orders.","tags":["Ecommerce"],"parameters":[{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"count","in":"query","description":"The number of records to return. Default value is 10. Maximum value is 1000","required":false,"schema":{"type":"integer","maximum":1000,"default":10}},{"name":"offset","in":"query","description":"Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0.","required":false,"schema":{"type":"integer","default":0}},{"name":"campaign_id","in":"query","description":"Restrict results to orders with a specific `campaign_id` value.","required":false,"schema":{"type":"string"}},{"name":"outreach_id","in":"query","description":"Restrict results to orders with a specific `outreach_id` value.","required":false,"schema":{"type":"string"}},{"name":"customer_id","in":"query","description":"Restrict results to orders made by a specific customer.","required":false,"schema":{"type":"string"}},{"name":"has_outreach","in":"query","description":"Restrict results to orders that have an outreach attached. For example, an email campaign or Facebook ad.","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ecommerce_list-orders_Response_200"}}}}},"security":[{"bearerToken":[]}]}},"/3.0/ecommerce/stores":{"get":{"operationId":"ecommerce_list-stores","summary":"List stores","description":"Get information about all stores in the account.","tags":["Ecommerce"],"parameters":[{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"count","in":"query","description":"The number of records to return. Default value is 10. Maximum value is 1000","required":false,"schema":{"type":"integer","maximum":1000,"default":10}},{"name":"offset","in":"query","description":"Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0.","required":false,"schema":{"type":"integer","default":0}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ecommerce_list-stores_Response_200"}}}}},"security":[{"bearerToken":[]}]},"post":{"operationId":"ecommerce_create-store","summary":"Add store","description":"Add a new store to your Mailchimp account.","tags":["Ecommerce"],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ECommerceStore"}}}}},"requestBody":{"description":"An individual store in an account.","content":{"application/json":{"schema":{"type":"object","properties":{"address":{"$ref":"#/components/schemas/30EcommerceStoresPostRequestBodyContentApplicationJsonSchemaAddress","description":"The store address."},"currency_code":{"type":"string","description":"The three-letter ISO 4217 code for the currency that the store accepts."},"domain":{"type":"string","description":"The store domain. This parameter is required for Connected Sites and Google Ads."},"email_address":{"type":"string","description":"The email address for the store."},"id":{"type":"string","minLength":1,"description":"The unique identifier for the store."},"is_syncing":{"type":"boolean","description":"Whether to disable automations because the store is currently [syncing](https://mailchimp.com/developer/marketing/docs/e-commerce/#pausing-store-automations)."},"list_id":{"type":"string","description":"The unique identifier for the list associated with the store. The `list_id` for a specific store cannot change."},"money_format":{"type":"string","description":"The currency format for the store. For example: `$`, `£`, etc."},"name":{"type":"string","description":"The name of the store."},"phone":{"type":"string","description":"The store phone number."},"platform":{"type":"string","description":"The e-commerce platform of the store."},"primary_locale":{"type":"string","description":"The primary locale for the store. For example: `en`, `de`, etc."},"timezone":{"type":"string","description":"The timezone for the store."}},"required":["currency_code","id","list_id","name"]}}}},"security":[{"bearerToken":[]}]}},"/3.0/ecommerce/stores/{store_id}":{"get":{"operationId":"ecommerce_get-store","summary":"Get store info","description":"Get information about a specific store.","tags":["Ecommerce"],"parameters":[{"name":"store_id","in":"path","description":"The store id.","required":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ECommerceStore"}}}}},"security":[{"bearerToken":[]}]},"patch":{"operationId":"ecommerce_update-store","summary":"Update store","description":"Update a store.","tags":["Ecommerce"],"parameters":[{"name":"store_id","in":"path","description":"The store id.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ECommerceStore"}}}}},"requestBody":{"description":"An individual store in an account.","content":{"application/json":{"schema":{"type":"object","properties":{"address":{"$ref":"#/components/schemas/30EcommerceStoresStoreIdPatchRequestBodyContentApplicationJsonSchemaAddress","description":"The store address."},"currency_code":{"type":"string","description":"The three-letter ISO 4217 code for the currency that the store accepts."},"domain":{"type":"string","description":"The store domain."},"email_address":{"type":"string","description":"The email address for the store."},"is_syncing":{"type":"boolean","description":"Whether to disable automations because the store is currently [syncing](https://mailchimp.com/developer/marketing/docs/e-commerce/#pausing-store-automations)."},"money_format":{"type":"string","description":"The currency format for the store. For example: `$`, `£`, etc."},"name":{"type":"string","description":"The name of the store."},"phone":{"type":"string","description":"The store phone number."},"platform":{"type":"string","description":"The e-commerce platform of the store."},"primary_locale":{"type":"string","description":"The primary locale for the store. For example: `en`, `de`, etc."},"timezone":{"type":"string","description":"The timezone for the store."}}}}}},"security":[{"bearerToken":[]}]},"delete":{"operationId":"ecommerce_delete-store","summary":"Delete store","description":"Delete a store. Deleting a store will also delete any associated subresources, including Customers, Orders, Products, and Carts.","tags":["Ecommerce"],"parameters":[{"name":"store_id","in":"path","description":"The store id.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Empty Response","content":{"application/json":{"schema":{"type":"object","properties":{}}}}}},"security":[{"bearerToken":[]}]}},"/3.0/ecommerce/stores/{store_id}/carts":{"get":{"operationId":"ecommerce_list-store-carts","summary":"List carts","description":"Get information about a store's carts.","tags":["Ecommerce"],"parameters":[{"name":"store_id","in":"path","description":"The store id.","required":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"count","in":"query","description":"The number of records to return. Default value is 10. Maximum value is 1000","required":false,"schema":{"type":"integer","maximum":1000,"default":10}},{"name":"offset","in":"query","description":"Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0.","required":false,"schema":{"type":"integer","default":0}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ecommerce_list-store-carts_Response_200"}}}}},"security":[{"bearerToken":[]}]},"post":{"operationId":"ecommerce_create-store-cart","summary":"Add cart","description":"Add a new cart to a store.","tags":["Ecommerce"],"parameters":[{"name":"store_id","in":"path","description":"The store id.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ECommerceCart"}}}}},"requestBody":{"description":"Information about a specific cart.","content":{"application/json":{"schema":{"type":"object","properties":{"campaign_id":{"type":"string","description":"A string that uniquely identifies the campaign for a cart."},"checkout_url":{"type":"string","description":"The URL for the cart. This parameter is required for [Abandoned Cart](https://mailchimp.com/help/create-a-classic-abandoned-cart-email/) automations."},"currency_code":{"type":"string","description":"The three-letter ISO 4217 code for the currency that the cart uses."},"customer":{"$ref":"#/components/schemas/EcommerceStoresCartsPost"},"id":{"$ref":"#/components/schemas/30EcommerceStoresStoreIdCartsPostRequestBodyContentApplicationJsonSchemaId","description":"A unique identifier for the cart."},"lines":{"type":"array","items":{"$ref":"#/components/schemas/30EcommerceStoresStoreIdCartsPostRequestBodyContentApplicationJsonSchemaLinesItems"},"description":"An array of the cart's line items."},"order_total":{"$ref":"#/components/schemas/30EcommerceStoresStoreIdCartsPostRequestBodyContentApplicationJsonSchemaOrderTotal"},"tax_total":{"$ref":"#/components/schemas/30EcommerceStoresStoreIdCartsPostRequestBodyContentApplicationJsonSchemaTaxTotal"}},"required":["currency_code","customer","id","lines","order_total"]}}}},"security":[{"bearerToken":[]}]}},"/3.0/ecommerce/stores/{store_id}/carts/{cart_id}":{"get":{"operationId":"ecommerce_get-store-cart","summary":"Get cart info","description":"Get information about a specific cart.","tags":["Ecommerce"],"parameters":[{"name":"store_id","in":"path","description":"The store id.","required":true,"schema":{"type":"string"}},{"name":"cart_id","in":"path","description":"The id for the cart.","required":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ECommerceCart"}}}}},"security":[{"bearerToken":[]}]},"patch":{"operationId":"ecommerce_update-store-cart","summary":"Update cart","description":"Update a specific cart.","tags":["Ecommerce"],"parameters":[{"name":"store_id","in":"path","description":"The store id.","required":true,"schema":{"type":"string"}},{"name":"cart_id","in":"path","description":"The id for the cart.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ECommerceCart"}}}}},"requestBody":{"description":"Information about a specific cart.","content":{"application/json":{"schema":{"type":"object","properties":{"campaign_id":{"type":"string","description":"A string that uniquely identifies the campaign associated with a cart."},"checkout_url":{"type":"string","description":"The URL for the cart. This parameter is required for [Abandoned Cart](https://mailchimp.com/help/create-a-classic-abandoned-cart-email/) automations."},"currency_code":{"type":"string","description":"The three-letter ISO 4217 code for the currency that the cart uses."},"customer":{"$ref":"#/components/schemas/EcommerceStoresCartsPatch"},"id":{"$ref":"#/components/schemas/30EcommerceStoresStoreIdCartsCartIdPatchRequestBodyContentApplicationJsonSchemaId","description":"A unique identifier for the cart."},"lines":{"type":"array","items":{"$ref":"#/components/schemas/30EcommerceStoresStoreIdCartsCartIdPatchRequestBodyContentApplicationJsonSchemaLinesItems"},"description":"An array of the cart's line items."},"order_total":{"$ref":"#/components/schemas/30EcommerceStoresStoreIdCartsCartIdPatchRequestBodyContentApplicationJsonSchemaOrderTotal"},"tax_total":{"$ref":"#/components/schemas/30EcommerceStoresStoreIdCartsCartIdPatchRequestBodyContentApplicationJsonSchemaTaxTotal"}}}}}},"security":[{"bearerToken":[]}]},"delete":{"operationId":"ecommerce_delete-store-cart","summary":"Delete cart","description":"Delete a cart.","tags":["Ecommerce"],"parameters":[{"name":"store_id","in":"path","description":"The store id.","required":true,"schema":{"type":"string"}},{"name":"cart_id","in":"path","description":"The id for the cart.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Empty Response","content":{"application/json":{"schema":{"type":"object","properties":{}}}}}},"security":[{"bearerToken":[]}]}},"/3.0/ecommerce/stores/{store_id}/carts/{cart_id}/lines":{"get":{"operationId":"ecommerce_list-store-cart-lines","summary":"List cart line items","description":"Get information about a cart's line items.","tags":["Ecommerce"],"parameters":[{"name":"store_id","in":"path","description":"The store id.","required":true,"schema":{"type":"string"}},{"name":"cart_id","in":"path","description":"The id for the cart.","required":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"count","in":"query","description":"The number of records to return. Default value is 10. Maximum value is 1000","required":false,"schema":{"type":"integer","maximum":1000,"default":10}},{"name":"offset","in":"query","description":"Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0.","required":false,"schema":{"type":"integer","default":0}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ecommerce_list-store-cart-lines_Response_200"}}}}},"security":[{"bearerToken":[]}]},"post":{"operationId":"ecommerce_create-store-cart-line","summary":"Add cart line item","description":"Add a new line item to an existing cart.","tags":["Ecommerce"],"parameters":[{"name":"store_id","in":"path","description":"The store id.","required":true,"schema":{"type":"string"}},{"name":"cart_id","in":"path","description":"The id for the cart.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ECommerceCartLineItem"}}}}},"requestBody":{"description":"Information about a specific cart line item.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","minLength":1,"description":"A unique identifier for the cart line item."},"price":{"$ref":"#/components/schemas/30EcommerceStoresStoreIdCartsCartIdLinesPostRequestBodyContentApplicationJsonSchemaPrice"},"product_id":{"type":"string","description":"A unique identifier for the product associated with the cart line item."},"product_variant_id":{"type":"string","description":"A unique identifier for the product variant associated with the cart line item."},"quantity":{"type":"integer","description":"The quantity of a cart line item."}},"required":["id","price","product_id","product_variant_id","quantity"]}}}},"security":[{"bearerToken":[]}]}},"/3.0/ecommerce/stores/{store_id}/carts/{cart_id}/lines/{line_id}":{"get":{"operationId":"ecommerce_get-store-cart-line","summary":"Get cart line item","description":"Get information about a specific cart line item.","tags":["Ecommerce"],"parameters":[{"name":"store_id","in":"path","description":"The store id.","required":true,"schema":{"type":"string"}},{"name":"cart_id","in":"path","description":"The id for the cart.","required":true,"schema":{"type":"string"}},{"name":"line_id","in":"path","description":"The id for the line item of a cart.","required":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ECommerceCartLineItem"}}}}},"security":[{"bearerToken":[]}]},"patch":{"operationId":"ecommerce_update-store-cart-line","summary":"Update cart line item","description":"Update a specific cart line item.","tags":["Ecommerce"],"parameters":[{"name":"store_id","in":"path","description":"The store id.","required":true,"schema":{"type":"string"}},{"name":"cart_id","in":"path","description":"The id for the cart.","required":true,"schema":{"type":"string"}},{"name":"line_id","in":"path","description":"The id for the line item of a cart.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ECommerceCartLineItem"}}}}},"requestBody":{"description":"Information about a specific cart line item.","content":{"application/json":{"schema":{"type":"object","properties":{"price":{"$ref":"#/components/schemas/30EcommerceStoresStoreIdCartsCartIdLinesLineIdPatchRequestBodyContentApplicationJsonSchemaPrice"},"product_id":{"type":"string","description":"A unique identifier for the product associated with the cart line item."},"product_variant_id":{"type":"string","description":"A unique identifier for the product variant associated with the cart line item."},"quantity":{"type":"integer","description":"The quantity of a cart line item."}}}}}},"security":[{"bearerToken":[]}]},"delete":{"operationId":"ecommerce_delete-store-cart-line","summary":"Delete cart line item","description":"Delete a specific cart line item.","tags":["Ecommerce"],"parameters":[{"name":"store_id","in":"path","description":"The store id.","required":true,"schema":{"type":"string"}},{"name":"cart_id","in":"path","description":"The id for the cart.","required":true,"schema":{"type":"string"}},{"name":"line_id","in":"path","description":"The id for the line item of a cart.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Empty Response","content":{"application/json":{"schema":{"type":"object","properties":{}}}}}},"security":[{"bearerToken":[]}]}},"/3.0/ecommerce/stores/{store_id}/customers":{"get":{"operationId":"ecommerce_list-store-customers","summary":"List customers","description":"Get information about a store's customers.","tags":["Ecommerce"],"parameters":[{"name":"store_id","in":"path","description":"The store id.","required":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"count","in":"query","description":"The number of records to return. Default value is 10. Maximum value is 1000","required":false,"schema":{"type":"integer","maximum":1000,"default":10}},{"name":"offset","in":"query","description":"Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0.","required":false,"schema":{"type":"integer","default":0}},{"name":"email_address","in":"query","description":"Restrict the response to customers with the email address.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ecommerce_list-store-customers_Response_200"}}}}},"security":[{"bearerToken":[]}]},"post":{"operationId":"ecommerce_create-store-customer","summary":"Add customer","description":"Add a new customer to a store.","tags":["Ecommerce"],"parameters":[{"name":"store_id","in":"path","description":"The store id.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ECommerceCustomer"}}}}},"requestBody":{"description":"Information about a specific customer.","content":{"application/json":{"schema":{"type":"object","properties":{"address":{"$ref":"#/components/schemas/30EcommerceStoresStoreIdCustomersPostRequestBodyContentApplicationJsonSchemaAddress","description":"The customer's address."},"company":{"type":"string","description":"The customer's company."},"email_address":{"type":"string","description":"The customer's email address."},"first_name":{"type":"string","description":"The customer's first name."},"id":{"type":"string","pattern":"\\S","minLength":1,"maxLength":50,"description":"A unique identifier for the customer. Limited to 50 characters."},"last_name":{"type":"string","description":"The customer's last name."},"opt_in_status":{"type":"boolean","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)."},"sms_phone_number":{"type":"string","description":"A US phone number for SMS contact."},"total_spent":{"$ref":"#/components/schemas/30EcommerceStoresStoreIdCustomersPostRequestBodyContentApplicationJsonSchemaTotalSpent"}},"required":["id","opt_in_status"]}}}},"security":[{"bearerToken":[]}]}},"/3.0/ecommerce/stores/{store_id}/customers/{customer_id}":{"get":{"operationId":"ecommerce_get-store-customer","summary":"Get customer info","description":"Get information about a specific customer.","tags":["Ecommerce"],"parameters":[{"name":"store_id","in":"path","description":"The store id.","required":true,"schema":{"type":"string"}},{"name":"customer_id","in":"path","description":"The id for the customer of a store.","required":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ECommerceCustomer"}}}}},"security":[{"bearerToken":[]}]},"patch":{"operationId":"ecommerce_update-store-customer","summary":"Update customer","description":"Update a customer.","tags":["Ecommerce"],"parameters":[{"name":"store_id","in":"path","description":"The store id.","required":true,"schema":{"type":"string"}},{"name":"customer_id","in":"path","description":"The id for the customer of a store.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ECommerceCustomer"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EcommerceStoresCartsPatch"}}}},"security":[{"bearerToken":[]}]},"put":{"operationId":"ecommerce_upsert-store-customer","summary":"Add or update customer","description":"Add or update a customer.","tags":["Ecommerce"],"parameters":[{"name":"store_id","in":"path","description":"The store id.","required":true,"schema":{"type":"string"}},{"name":"customer_id","in":"path","description":"The id for the customer of a store.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ECommerceCustomer"}}}}},"requestBody":{"description":"Information about a specific customer. Orders for existing customers should include only the `id` parameter in the `customer` object body.","content":{"application/json":{"schema":{"type":"object","properties":{"address":{"$ref":"#/components/schemas/30EcommerceStoresStoreIdCustomersCustomerIdPutRequestBodyContentApplicationJsonSchemaAddress","description":"The customer's address."},"company":{"type":"string","description":"The customer's company."},"email_address":{"type":"string","description":"The customer's email address."},"first_name":{"type":"string","description":"The customer's first name."},"id":{"type":"string","pattern":"\\S","minLength":1,"maxLength":50,"description":"A unique identifier for the customer. Limited to 50 characters."},"last_name":{"type":"string","description":"The customer's last name."},"opt_in_status":{"type":"boolean","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)."},"sms_phone_number":{"type":"string","description":"A US phone number for SMS contact."},"total_spent":{"$ref":"#/components/schemas/30EcommerceStoresStoreIdCustomersCustomerIdPutRequestBodyContentApplicationJsonSchemaTotalSpent"}}}}}},"security":[{"bearerToken":[]}]},"delete":{"operationId":"ecommerce_delete-store-customer","summary":"Delete customer","description":"Delete a customer from a store.","tags":["Ecommerce"],"parameters":[{"name":"store_id","in":"path","description":"The store id.","required":true,"schema":{"type":"string"}},{"name":"customer_id","in":"path","description":"The id for the customer of a store.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Empty Response","content":{"application/json":{"schema":{"type":"object","properties":{}}}}}},"security":[{"bearerToken":[]}]}},"/3.0/ecommerce/stores/{store_id}/orders":{"get":{"operationId":"ecommerce_list-store-orders","summary":"List orders","description":"Get information about a store's orders.","tags":["Ecommerce"],"parameters":[{"name":"store_id","in":"path","description":"The store id.","required":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"count","in":"query","description":"The number of records to return. Default value is 10. Maximum value is 1000","required":false,"schema":{"type":"integer","maximum":1000,"default":10}},{"name":"offset","in":"query","description":"Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0.","required":false,"schema":{"type":"integer","default":0}},{"name":"customer_id","in":"query","description":"Restrict results to orders made by a specific customer.","required":false,"schema":{"type":"string"}},{"name":"has_outreach","in":"query","description":"Restrict results to orders that have an outreach attached. For example, an email campaign or Facebook ad.","required":false,"schema":{"type":"boolean"}},{"name":"campaign_id","in":"query","description":"Restrict results to orders with a specific `campaign_id` value.","required":false,"schema":{"type":"string"}},{"name":"outreach_id","in":"query","description":"Restrict results to orders with a specific `outreach_id` value.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ecommerce_list-store-orders_Response_200"}}}}},"security":[{"bearerToken":[]}]},"post":{"operationId":"ecommerce_create-store-order","summary":"Add order","description":"Add a new order to a store.","tags":["Ecommerce"],"parameters":[{"name":"store_id","in":"path","description":"The store id.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ECommerceOrder"}}}}},"requestBody":{"description":"Information about a specific order.","content":{"application/json":{"schema":{"type":"object","properties":{"billing_address":{"$ref":"#/components/schemas/30EcommerceStoresStoreIdOrdersPostRequestBodyContentApplicationJsonSchemaBillingAddress","description":"The billing address for the order."},"campaign_id":{"type":"string","description":"A string that uniquely identifies the campaign for an order."},"cart_id":{"$ref":"#/components/schemas/30EcommerceStoresStoreIdOrdersPostRequestBodyContentApplicationJsonSchemaCartId","description":"A cart id that the order was placed for."},"cancelled_at_foreign":{"type":"string","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."},"currency_code":{"type":"string","description":"The three-letter ISO 4217 code for the currency that the store accepts."},"customer":{"$ref":"#/components/schemas/EcommerceStoresCartsPost"},"discount_total":{"$ref":"#/components/schemas/30EcommerceStoresStoreIdOrdersPostRequestBodyContentApplicationJsonSchemaDiscountTotal"},"financial_status":{"type":"string","description":"The order status. Use this parameter to trigger [Order Notifications](https://mailchimp.com/developer/marketing/docs/e-commerce/#order-notifications)."},"fulfillment_status":{"type":"string","description":"The fulfillment status for the order. Use this parameter to trigger [Order Notifications](https://mailchimp.com/developer/marketing/docs/e-commerce/#order-notifications)."},"id":{"type":"string","pattern":"\\S","minLength":1,"description":"A unique identifier for the order."},"landing_site":{"type":"string","description":"The URL for the page where the buyer landed when entering the shop."},"lines":{"type":"array","items":{"$ref":"#/components/schemas/30EcommerceStoresStoreIdOrdersPostRequestBodyContentApplicationJsonSchemaLinesItems"},"description":"An array of the order's line items."},"order_total":{"$ref":"#/components/schemas/30EcommerceStoresStoreIdOrdersPostRequestBodyContentApplicationJsonSchemaOrderTotal"},"order_url":{"type":"string","description":"The URL for the order."},"outreach":{"$ref":"#/components/schemas/30EcommerceStoresStoreIdOrdersPostRequestBodyContentApplicationJsonSchemaOutreach","description":"The outreach associated with this order. For example, an email campaign or Facebook ad."},"processed_at_foreign":{"type":"string","description":"The date and time the order was processed in ISO 8601 format."},"promos":{"type":"array","items":{"$ref":"#/components/schemas/30EcommerceStoresStoreIdOrdersPostRequestBodyContentApplicationJsonSchemaPromosItems"},"description":"The promo codes applied on the order"},"shipping_address":{"$ref":"#/components/schemas/30EcommerceStoresStoreIdOrdersPostRequestBodyContentApplicationJsonSchemaShippingAddress","description":"The shipping address for the order."},"shipping_total":{"$ref":"#/components/schemas/30EcommerceStoresStoreIdOrdersPostRequestBodyContentApplicationJsonSchemaShippingTotal"},"tax_total":{"$ref":"#/components/schemas/30EcommerceStoresStoreIdOrdersPostRequestBodyContentApplicationJsonSchemaTaxTotal"},"tracking_carrier":{"type":"string","description":"The tracking carrier associated with the order."},"tracking_code":{"$ref":"#/components/schemas/30EcommerceStoresStoreIdOrdersPostRequestBodyContentApplicationJsonSchemaTrackingCode","description":"The Mailchimp tracking code for the order. Uses the 'mc_tc' parameter in E-Commerce tracking URLs."},"tracking_number":{"type":"string","description":"The tracking number associated with the order."},"tracking_url":{"type":"string","description":"The tracking URL associated with the order."},"updated_at_foreign":{"type":"string","description":"The date and time the order was updated in ISO 8601 format."}},"required":["currency_code","customer","id","lines","order_total"]}}}},"security":[{"bearerToken":[]}]}},"/3.0/ecommerce/stores/{store_id}/orders/{order_id}":{"get":{"operationId":"ecommerce_get-store-order","summary":"Get order info","description":"Get information about a specific order.","tags":["Ecommerce"],"parameters":[{"name":"store_id","in":"path","description":"The store id.","required":true,"schema":{"type":"string"}},{"name":"order_id","in":"path","description":"The id for the order in a store.","required":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ECommerceOrder"}}}}},"security":[{"bearerToken":[]}]},"patch":{"operationId":"ecommerce_update-store-order","summary":"Update order","description":"Update a specific order.","tags":["Ecommerce"],"parameters":[{"name":"store_id","in":"path","description":"The store id.","required":true,"schema":{"type":"string"}},{"name":"order_id","in":"path","description":"The id for the order in a store.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ECommerceOrder"}}}}},"requestBody":{"description":"Information about a specific order.","content":{"application/json":{"schema":{"type":"object","properties":{"billing_address":{"$ref":"#/components/schemas/30EcommerceStoresStoreIdOrdersOrderIdPatchRequestBodyContentApplicationJsonSchemaBillingAddress","description":"The billing address for the order."},"campaign_id":{"type":"string","description":"A string that uniquely identifies the campaign associated with an order."},"cart_id":{"$ref":"#/components/schemas/30EcommerceStoresStoreIdOrdersOrderIdPatchRequestBodyContentApplicationJsonSchemaCartId","description":"A cart id that the order was placed for."},"cancelled_at_foreign":{"type":"string","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."},"currency_code":{"type":"string","description":"The three-letter ISO 4217 code for the currency that the store accepts."},"customer":{"$ref":"#/components/schemas/EcommerceStoresCartsPatch"},"discount_total":{"$ref":"#/components/schemas/30EcommerceStoresStoreIdOrdersOrderIdPatchRequestBodyContentApplicationJsonSchemaDiscountTotal"},"financial_status":{"type":"string","description":"The order status. Use this parameter to trigger [Order Notifications](https://mailchimp.com/developer/marketing/docs/e-commerce/#order-notifications)."},"fulfillment_status":{"type":"string","description":"The fulfillment status for the order. Use this parameter to trigger [Order Notifications](https://mailchimp.com/developer/marketing/docs/e-commerce/#order-notifications)."},"id":{"type":"string","pattern":"\\S","minLength":1,"description":"A unique identifier for the order."},"landing_site":{"type":"string","description":"The URL for the page where the buyer landed when entering the shop."},"lines":{"type":"array","items":{"$ref":"#/components/schemas/30EcommerceStoresStoreIdOrdersOrderIdPatchRequestBodyContentApplicationJsonSchemaLinesItems"},"description":"An array of the order's line items."},"order_total":{"$ref":"#/components/schemas/30EcommerceStoresStoreIdOrdersOrderIdPatchRequestBodyContentApplicationJsonSchemaOrderTotal"},"order_url":{"type":"string","description":"The URL for the order."},"outreach":{"$ref":"#/components/schemas/30EcommerceStoresStoreIdOrdersOrderIdPatchRequestBodyContentApplicationJsonSchemaOutreach","description":"The outreach associated with this order. For example, an email campaign or Facebook ad."},"processed_at_foreign":{"type":"string","description":"The date and time the order was processed in ISO 8601 format."},"promos":{"type":"array","items":{"$ref":"#/components/schemas/30EcommerceStoresStoreIdOrdersOrderIdPatchRequestBodyContentApplicationJsonSchemaPromosItems"},"description":"The promo codes applied on the order. Note: Patch will completely replace the value of promos with the new one provided."},"shipping_address":{"$ref":"#/components/schemas/30EcommerceStoresStoreIdOrdersOrderIdPatchRequestBodyContentApplicationJsonSchemaShippingAddress","description":"The shipping address for the order."},"shipping_total":{"$ref":"#/components/schemas/30EcommerceStoresStoreIdOrdersOrderIdPatchRequestBodyContentApplicationJsonSchemaShippingTotal"},"tax_total":{"$ref":"#/components/schemas/30EcommerceStoresStoreIdOrdersOrderIdPatchRequestBodyContentApplicationJsonSchemaTaxTotal"},"tracking_carrier":{"type":"string","description":"The tracking carrier associated with the order."},"tracking_code":{"$ref":"#/components/schemas/30EcommerceStoresStoreIdOrdersOrderIdPatchRequestBodyContentApplicationJsonSchemaTrackingCode","description":"The Mailchimp tracking code for the order. Uses the 'mc_tc' parameter in E-Commerce tracking URLs."},"tracking_number":{"type":"string","description":"The tracking number associated with the order."},"tracking_url":{"type":"string","description":"The tracking URL associated with the order."},"updated_at_foreign":{"type":"string","description":"The date and time the order was updated in ISO 8601 format."}}}}}},"security":[{"bearerToken":[]}]},"delete":{"operationId":"ecommerce_delete-store-order","summary":"Delete order","description":"Delete an order.","tags":["Ecommerce"],"parameters":[{"name":"store_id","in":"path","description":"The store id.","required":true,"schema":{"type":"string"}},{"name":"order_id","in":"path","description":"The id for the order in a store.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Empty Response","content":{"application/json":{"schema":{"type":"object","properties":{}}}}}},"security":[{"bearerToken":[]}]}},"/3.0/ecommerce/stores/{store_id}/orders/{order_id}/lines":{"get":{"operationId":"ecommerce_list-store-order-lines","summary":"List order line items","description":"Get information about an order's line items.","tags":["Ecommerce"],"parameters":[{"name":"store_id","in":"path","description":"The store id.","required":true,"schema":{"type":"string"}},{"name":"order_id","in":"path","description":"The id for the order in a store.","required":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"count","in":"query","description":"The number of records to return. Default value is 10. Maximum value is 1000","required":false,"schema":{"type":"integer","maximum":1000,"default":10}},{"name":"offset","in":"query","description":"Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0.","required":false,"schema":{"type":"integer","default":0}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ecommerce_list-store-order-lines_Response_200"}}}}},"security":[{"bearerToken":[]}]},"post":{"operationId":"ecommerce_create-store-order-line","summary":"Add order line item","description":"Add a new line item to an existing order.","tags":["Ecommerce"],"parameters":[{"name":"store_id","in":"path","description":"The store id.","required":true,"schema":{"type":"string"}},{"name":"order_id","in":"path","description":"The id for the order in a store.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ECommerceOrderLineItem"}}}}},"requestBody":{"description":"Information about a specific order line.","content":{"application/json":{"schema":{"type":"object","properties":{"discount":{"$ref":"#/components/schemas/30EcommerceStoresStoreIdOrdersOrderIdLinesPostRequestBodyContentApplicationJsonSchemaDiscount"},"id":{"type":"string","minLength":1,"description":"A unique identifier for the order line item."},"price":{"$ref":"#/components/schemas/30EcommerceStoresStoreIdOrdersOrderIdLinesPostRequestBodyContentApplicationJsonSchemaPrice"},"product":{"$ref":"#/components/schemas/EcommerceStoresOrdersPost"},"product_id":{"type":"string","description":"A unique identifier for the product associated with the order line item."},"product_variant_id":{"type":"string","description":"A unique identifier for the product variant associated with the order line item."},"quantity":{"type":"integer","description":"The quantity of an order line item."}},"required":["id","price","product_id","product_variant_id","quantity"]}}}},"security":[{"bearerToken":[]}]}},"/3.0/ecommerce/stores/{store_id}/orders/{order_id}/lines/{line_id}":{"get":{"operationId":"ecommerce_get-store-order-line","summary":"Get order line item","description":"Get information about a specific order line item.","tags":["Ecommerce"],"parameters":[{"name":"store_id","in":"path","description":"The store id.","required":true,"schema":{"type":"string"}},{"name":"order_id","in":"path","description":"The id for the order in a store.","required":true,"schema":{"type":"string"}},{"name":"line_id","in":"path","description":"The id for the line item of an order.","required":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ECommerceOrderLineItem"}}}}},"security":[{"bearerToken":[]}]},"patch":{"operationId":"ecommerce_update-store-order-line","summary":"Update order line item","description":"Update a specific order line item.","tags":["Ecommerce"],"parameters":[{"name":"store_id","in":"path","description":"The store id.","required":true,"schema":{"type":"string"}},{"name":"order_id","in":"path","description":"The id for the order in a store.","required":true,"schema":{"type":"string"}},{"name":"line_id","in":"path","description":"The id for the line item of an order.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ECommerceOrderLineItem"}}}}},"requestBody":{"description":"Information about a specific order line.","content":{"application/json":{"schema":{"type":"object","properties":{"discount":{"$ref":"#/components/schemas/30EcommerceStoresStoreIdOrdersOrderIdLinesLineIdPatchRequestBodyContentApplicationJsonSchemaDiscount"},"id":{"type":"string","minLength":1,"description":"A unique identifier for the order line item."},"price":{"$ref":"#/components/schemas/30EcommerceStoresStoreIdOrdersOrderIdLinesLineIdPatchRequestBodyContentApplicationJsonSchemaPrice"},"product_id":{"type":"string","description":"A unique identifier for the product associated with the order line item."},"product_variant_id":{"type":"string","description":"A unique identifier for the product variant associated with the order line item."},"quantity":{"type":"integer","description":"The quantity of an order line item."}}}}}},"security":[{"bearerToken":[]}]},"delete":{"operationId":"ecommerce_delete-store-order-line","summary":"Delete order line item","description":"Delete a specific order line item.","tags":["Ecommerce"],"parameters":[{"name":"store_id","in":"path","description":"The store id.","required":true,"schema":{"type":"string"}},{"name":"order_id","in":"path","description":"The id for the order in a store.","required":true,"schema":{"type":"string"}},{"name":"line_id","in":"path","description":"The id for the line item of an order.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Empty Response","content":{"application/json":{"schema":{"type":"object","properties":{}}}}}},"security":[{"bearerToken":[]}]}},"/3.0/ecommerce/stores/{store_id}/products":{"get":{"operationId":"ecommerce_list-store-products","summary":"List product","description":"Get information about a store's products.","tags":["Ecommerce"],"parameters":[{"name":"store_id","in":"path","description":"The store id.","required":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"count","in":"query","description":"The number of records to return. Default value is 10. Maximum value is 1000","required":false,"schema":{"type":"integer","maximum":1000,"default":10}},{"name":"offset","in":"query","description":"Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0.","required":false,"schema":{"type":"integer","default":0}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ecommerce_list-store-products_Response_200"}}}}},"security":[{"bearerToken":[]}]},"post":{"operationId":"ecommerce_create-store-product","summary":"Add product","description":"Add a new product to a store.","tags":["Ecommerce"],"parameters":[{"name":"store_id","in":"path","description":"The store id.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ECommerceProduct"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EcommerceStoresOrdersPost"}}}},"security":[{"bearerToken":[]}]}},"/3.0/ecommerce/stores/{store_id}/products/{product_id}":{"get":{"operationId":"ecommerce_get-store-product","summary":"Get product info","description":"Get information about a specific product.","tags":["Ecommerce"],"parameters":[{"name":"store_id","in":"path","description":"The store id.","required":true,"schema":{"type":"string"}},{"name":"product_id","in":"path","description":"The id for the product of a store.","required":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ECommerceProduct"}}}}},"security":[{"bearerToken":[]}]},"patch":{"operationId":"ecommerce_update-store-product","summary":"Update product","description":"Update a specific product.","tags":["Ecommerce"],"parameters":[{"name":"store_id","in":"path","description":"The store id.","required":true,"schema":{"type":"string"}},{"name":"product_id","in":"path","description":"The id for the product of a store.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ECommerceProduct"}}}}},"requestBody":{"description":"Information about a specific product.","content":{"application/json":{"schema":{"type":"object","properties":{"description":{"type":"string","description":"The description of a product."},"handle":{"type":"string","description":"The handle of a product."},"id":{"$ref":"#/components/schemas/30EcommerceStoresStoreIdProductsProductIdPatchRequestBodyContentApplicationJsonSchemaId","description":"A unique identifier for the product."},"image_url":{"type":"string","description":"The image URL for a product."},"images":{"type":"array","items":{"$ref":"#/components/schemas/30EcommerceStoresStoreIdProductsProductIdPatchRequestBodyContentApplicationJsonSchemaImagesItems"},"description":"An array of the product's images."},"published_at_foreign":{"type":"string","description":"The date and time the product was published in ISO 8601 format."},"title":{"type":"string","pattern":"\\S","minLength":1,"description":"The title of a product."},"type":{"type":"string","description":"The type of product."},"url":{"type":"string","description":"The URL for a product."},"variants":{"type":"array","items":{"$ref":"#/components/schemas/30EcommerceStoresStoreIdProductsProductIdPatchRequestBodyContentApplicationJsonSchemaVariantsItems"},"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."},"vendor":{"type":"string","description":"The vendor for a product."}}}}}},"security":[{"bearerToken":[]}]},"put":{"operationId":"ecommerce_upsert-store-product","summary":"Create or update product","description":"Update a specific product.","tags":["Ecommerce"],"parameters":[{"name":"store_id","in":"path","description":"The store id.","required":true,"schema":{"type":"string"}},{"name":"product_id","in":"path","description":"The id for the product of a store.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ECommerceProduct"}}}}},"requestBody":{"description":"Information about a specific product.","content":{"application/json":{"schema":{"type":"object","properties":{"description":{"type":"string","description":"The description of a product."},"handle":{"type":"string","description":"The handle of a product."},"id":{"$ref":"#/components/schemas/30EcommerceStoresStoreIdProductsProductIdPutRequestBodyContentApplicationJsonSchemaId","description":"A unique identifier for the product."},"image_url":{"type":"string","description":"The image URL for a product."},"images":{"type":"array","items":{"$ref":"#/components/schemas/30EcommerceStoresStoreIdProductsProductIdPutRequestBodyContentApplicationJsonSchemaImagesItems"},"description":"An array of the product's images."},"published_at_foreign":{"type":"string","description":"The date and time the product was published."},"title":{"type":"string","pattern":"\\S","minLength":1,"description":"The title of a product."},"type":{"type":"string","description":"The type of product."},"url":{"type":"string","description":"The URL for a product."},"variants":{"type":"array","items":{"$ref":"#/components/schemas/30EcommerceStoresStoreIdProductsProductIdPutRequestBodyContentApplicationJsonSchemaVariantsItems"},"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."},"vendor":{"type":"string","description":"The vendor for a product."}},"required":["id"]}}}},"security":[{"bearerToken":[]}]},"delete":{"operationId":"ecommerce_delete-store-product","summary":"Delete product","description":"Delete a product.","tags":["Ecommerce"],"parameters":[{"name":"store_id","in":"path","description":"The store id.","required":true,"schema":{"type":"string"}},{"name":"product_id","in":"path","description":"The id for the product of a store.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Empty Response","content":{"application/json":{"schema":{"type":"object","properties":{}}}}}},"security":[{"bearerToken":[]}]}},"/3.0/ecommerce/stores/{store_id}/products/{product_id}/images":{"get":{"operationId":"ecommerce_list-store-product-images","summary":"List product images","description":"Get information about a product's images.","tags":["Ecommerce"],"parameters":[{"name":"store_id","in":"path","description":"The store id.","required":true,"schema":{"type":"string"}},{"name":"product_id","in":"path","description":"The id for the product of a store.","required":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"count","in":"query","description":"The number of records to return. Default value is 10. Maximum value is 1000","required":false,"schema":{"type":"integer","maximum":1000,"default":10}},{"name":"offset","in":"query","description":"Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0.","required":false,"schema":{"type":"integer","default":0}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ecommerce_list-store-product-images_Response_200"}}}}},"security":[{"bearerToken":[]}]},"post":{"operationId":"ecommerce_create-store-product-image","summary":"Add product image","description":"Add a new image to the product.","tags":["Ecommerce"],"parameters":[{"name":"store_id","in":"path","description":"The store id.","required":true,"schema":{"type":"string"}},{"name":"product_id","in":"path","description":"The id for the product of a store.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ecommerce_create-store-product-image_Response_200"}}}}},"requestBody":{"description":"Information about a specific product image.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":50,"description":"A unique identifier for the product image."},"url":{"type":"string","description":"The URL for a product image."},"variant_ids":{"type":"array","items":{"$ref":"#/components/schemas/30EcommerceStoresStoreIdProductsProductIdImagesPostRequestBodyContentApplicationJsonSchemaVariantIdsItems"},"description":"The list of product variants using the image."}},"required":["id","url"]}}}},"security":[{"bearerToken":[]}]}},"/3.0/ecommerce/stores/{store_id}/products/{product_id}/images/{image_id}":{"get":{"operationId":"ecommerce_get-store-product-image","summary":"Get product image info","description":"Get information about a specific product image.","tags":["Ecommerce"],"parameters":[{"name":"store_id","in":"path","description":"The store id.","required":true,"schema":{"type":"string"}},{"name":"product_id","in":"path","description":"The id for the product of a store.","required":true,"schema":{"type":"string"}},{"name":"image_id","in":"path","description":"The id for the product image.","required":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ecommerce_get-store-product-image_Response_200"}}}}},"security":[{"bearerToken":[]}]},"patch":{"operationId":"ecommerce_update-store-product-image","summary":"Update product image","description":"Update a product image.","tags":["Ecommerce"],"parameters":[{"name":"store_id","in":"path","description":"The store id.","required":true,"schema":{"type":"string"}},{"name":"product_id","in":"path","description":"The id for the product of a store.","required":true,"schema":{"type":"string"}},{"name":"image_id","in":"path","description":"The id for the product image.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ecommerce_update-store-product-image_Response_200"}}}}},"requestBody":{"description":"Information about a specific product image.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":50,"description":"A unique identifier for the product image."},"url":{"type":"string","description":"The URL for a product image."},"variant_ids":{"type":"array","items":{"$ref":"#/components/schemas/30EcommerceStoresStoreIdProductsProductIdImagesImageIdPatchRequestBodyContentApplicationJsonSchemaVariantIdsItems"},"description":"The list of product variants using the image."}}}}}},"security":[{"bearerToken":[]}]},"delete":{"operationId":"ecommerce_delete-store-product-image","summary":"Delete product image","description":"Delete a product image.","tags":["Ecommerce"],"parameters":[{"name":"store_id","in":"path","description":"The store id.","required":true,"schema":{"type":"string"}},{"name":"product_id","in":"path","description":"The id for the product of a store.","required":true,"schema":{"type":"string"}},{"name":"image_id","in":"path","description":"The id for the product image.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Empty Response","content":{"application/json":{"schema":{"type":"object","properties":{}}}}}},"security":[{"bearerToken":[]}]}},"/3.0/ecommerce/stores/{store_id}/products/{product_id}/variants":{"get":{"operationId":"ecommerce_list-store-product-variants","summary":"List product variants","description":"Get information about a product's variants.","tags":["Ecommerce"],"parameters":[{"name":"store_id","in":"path","description":"The store id.","required":true,"schema":{"type":"string"}},{"name":"product_id","in":"path","description":"The id for the product of a store.","required":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"count","in":"query","description":"The number of records to return. Default value is 10. Maximum value is 1000","required":false,"schema":{"type":"integer","maximum":1000,"default":10}},{"name":"offset","in":"query","description":"Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0.","required":false,"schema":{"type":"integer","default":0}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ecommerce_list-store-product-variants_Response_200"}}}}},"security":[{"bearerToken":[]}]},"post":{"operationId":"ecommerce_create-store-product-variant","summary":"Add product variant","description":"Add a new variant to the product.","tags":["Ecommerce"],"parameters":[{"name":"store_id","in":"path","description":"The store id.","required":true,"schema":{"type":"string"}},{"name":"product_id","in":"path","description":"The id for the product of a store.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ECommerceProductVariant"}}}}},"requestBody":{"description":"Information about a specific product variant.","content":{"application/json":{"schema":{"type":"object","properties":{"backorders":{"type":"string","description":"The backorders of a product variant."},"id":{"$ref":"#/components/schemas/30EcommerceStoresStoreIdProductsProductIdVariantsPostRequestBodyContentApplicationJsonSchemaId","description":"A unique identifier for the product variant."},"image_url":{"type":"string","description":"The image URL for a product variant."},"inventory_quantity":{"type":"integer","description":"The inventory quantity of a product variant."},"price":{"$ref":"#/components/schemas/30EcommerceStoresStoreIdProductsProductIdVariantsPostRequestBodyContentApplicationJsonSchemaPrice"},"sku":{"type":"string","description":"The stock keeping unit (SKU) of a product variant."},"title":{"type":"string","pattern":"\\S","minLength":1,"description":"The title of a product variant."},"url":{"type":"string","description":"The URL for a product variant."},"visibility":{"type":"string","description":"The visibility of a product variant."}},"required":["id","title"]}}}},"security":[{"bearerToken":[]}]}},"/3.0/ecommerce/stores/{store_id}/products/{product_id}/variants/{variant_id}":{"get":{"operationId":"ecommerce_get-store-product-variant","summary":"Get product variant info","description":"Get information about a specific product variant.","tags":["Ecommerce"],"parameters":[{"name":"store_id","in":"path","description":"The store id.","required":true,"schema":{"type":"string"}},{"name":"product_id","in":"path","description":"The id for the product of a store.","required":true,"schema":{"type":"string"}},{"name":"variant_id","in":"path","description":"The id for the product variant.","required":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ECommerceProductVariant"}}}}},"security":[{"bearerToken":[]}]},"patch":{"operationId":"ecommerce_update-store-product-variant","summary":"Update product variant","description":"Update a product variant.","tags":["Ecommerce"],"parameters":[{"name":"store_id","in":"path","description":"The store id.","required":true,"schema":{"type":"string"}},{"name":"product_id","in":"path","description":"The id for the product of a store.","required":true,"schema":{"type":"string"}},{"name":"variant_id","in":"path","description":"The id for the product variant.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ECommerceProductVariant"}}}}},"requestBody":{"description":"Information about a specific product variant.","content":{"application/json":{"schema":{"type":"object","properties":{"backorders":{"type":"string","description":"The backorders of a product variant."},"image_url":{"type":"string","description":"The image URL for a product variant."},"inventory_quantity":{"type":"integer","description":"The inventory quantity of a product variant."},"price":{"$ref":"#/components/schemas/30EcommerceStoresStoreIdProductsProductIdVariantsVariantIdPatchRequestBodyContentApplicationJsonSchemaPrice"},"sku":{"type":"string","description":"The stock keeping unit (SKU) of a product variant."},"title":{"type":"string","pattern":"\\S","minLength":1,"description":"The title of a product variant."},"url":{"type":"string","description":"The URL for a product variant."},"visibility":{"type":"string","description":"The visibility of a product variant."}}}}}},"security":[{"bearerToken":[]}]},"put":{"operationId":"ecommerce_upsert-store-product-variant","summary":"Add or update product variant","description":"Add or update a product variant.","tags":["Ecommerce"],"parameters":[{"name":"store_id","in":"path","description":"The store id.","required":true,"schema":{"type":"string"}},{"name":"product_id","in":"path","description":"The id for the product of a store.","required":true,"schema":{"type":"string"}},{"name":"variant_id","in":"path","description":"The id for the product variant.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ECommerceProductVariant"}}}}},"requestBody":{"description":"Information about a specific product variant.","content":{"application/json":{"schema":{"type":"object","properties":{"backorders":{"type":"string","description":"The backorders of a product variant."},"id":{"type":"string","pattern":"\\S","minLength":1,"description":"A unique identifier for the product variant."},"image_url":{"type":"string","description":"The image URL for a product variant."},"inventory_quantity":{"type":"integer","description":"The inventory quantity of a product variant."},"price":{"$ref":"#/components/schemas/30EcommerceStoresStoreIdProductsProductIdVariantsVariantIdPutRequestBodyContentApplicationJsonSchemaPrice"},"sku":{"type":"string","description":"The stock keeping unit (SKU) of a product variant."},"title":{"type":"string","pattern":"\\S","minLength":1,"description":"The title of a product variant."},"url":{"type":"string","description":"The URL for a product variant."},"visibility":{"type":"string","description":"The visibility of a product variant."}}}}}},"security":[{"bearerToken":[]}]},"delete":{"operationId":"ecommerce_delete-store-product-variant","summary":"Delete product variant","description":"Delete a product variant.","tags":["Ecommerce"],"parameters":[{"name":"store_id","in":"path","description":"The store id.","required":true,"schema":{"type":"string"}},{"name":"product_id","in":"path","description":"The id for the product of a store.","required":true,"schema":{"type":"string"}},{"name":"variant_id","in":"path","description":"The id for the product variant.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Empty Response","content":{"application/json":{"schema":{"type":"object","properties":{}}}}}},"security":[{"bearerToken":[]}]}},"/3.0/ecommerce/stores/{store_id}/promo-rules":{"get":{"operationId":"ecommerce_list-store-promo-rules","summary":"List promo rules","description":"Get information about a store's promo rules.","tags":["Ecommerce"],"parameters":[{"name":"store_id","in":"path","description":"The store id.","required":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"count","in":"query","description":"The number of records to return. Default value is 10. Maximum value is 1000","required":false,"schema":{"type":"integer","maximum":1000,"default":10}},{"name":"offset","in":"query","description":"Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0.","required":false,"schema":{"type":"integer","default":0}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ecommerce_list-store-promo-rules_Response_200"}}}}},"security":[{"bearerToken":[]}]},"post":{"operationId":"ecommerce_create-store-promo-rule","summary":"Add promo rule","description":"Add a new promo rule to a store.","tags":["Ecommerce"],"parameters":[{"name":"store_id","in":"path","description":"The store id.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ECommercePromoRule"}}}}},"requestBody":{"description":"Information about an Ecommerce Store's specific Promo Rule.","content":{"application/json":{"schema":{"type":"object","properties":{"amount":{"$ref":"#/components/schemas/30EcommerceStoresStoreIdPromoRulesPostRequestBodyContentApplicationJsonSchemaAmount"},"created_at_foreign":{"type":"string","description":"The date and time the promotion was created in ISO 8601 format."},"description":{"type":"string","description":"The description of a promotion restricted to UTF-8 characters with max length 255."},"enabled":{"type":"boolean","description":"Whether the promo rule is currently enabled."},"ends_at":{"$ref":"#/components/schemas/30EcommerceStoresStoreIdPromoRulesPostRequestBodyContentApplicationJsonSchemaEndsAt"},"id":{"type":"string","pattern":"\\S","minLength":1,"maxLength":50,"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."},"starts_at":{"$ref":"#/components/schemas/30EcommerceStoresStoreIdPromoRulesPostRequestBodyContentApplicationJsonSchemaStartsAt"},"target":{"$ref":"#/components/schemas/30EcommerceStoresStoreIdPromoRulesPostRequestBodyContentApplicationJsonSchemaTarget","description":"The target that the discount applies to."},"title":{"type":"string","description":"The title that will show up in promotion campaign. Restricted to UTF-8 characters with max length of 100 bytes."},"type":{"$ref":"#/components/schemas/30EcommerceStoresStoreIdPromoRulesPostRequestBodyContentApplicationJsonSchemaType","description":"Type of discount. For free shipping set type to fixed."},"updated_at_foreign":{"type":"string","description":"The date and time the promotion was updated in ISO 8601 format."}},"required":["amount","description","id","target","type"]}}}},"security":[{"bearerToken":[]}]}},"/3.0/ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}":{"get":{"operationId":"ecommerce_get-store-promo-rule","summary":"Get promo rule","description":"Get information about a specific promo rule.","tags":["Ecommerce"],"parameters":[{"name":"store_id","in":"path","description":"The store id.","required":true,"schema":{"type":"string"}},{"name":"promo_rule_id","in":"path","description":"The id for the promo rule of a store.","required":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ECommercePromoRule"}}}}},"security":[{"bearerToken":[]}]},"patch":{"operationId":"ecommerce_update-store-promo-rule","summary":"Update promo rule","description":"Update a promo rule.","tags":["Ecommerce"],"parameters":[{"name":"store_id","in":"path","description":"The store id.","required":true,"schema":{"type":"string"}},{"name":"promo_rule_id","in":"path","description":"The id for the promo rule of a store.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ECommercePromoRule"}}}}},"requestBody":{"description":"Information about an Ecommerce Store's specific Promo Rule.","content":{"application/json":{"schema":{"type":"object","properties":{"amount":{"$ref":"#/components/schemas/30EcommerceStoresStoreIdPromoRulesPromoRuleIdPatchRequestBodyContentApplicationJsonSchemaAmount"},"created_at_foreign":{"type":"string","description":"The date and time the promotion was created in ISO 8601 format."},"description":{"type":"string","description":"The description of a promotion restricted to UTF-8 characters with max length 255."},"enabled":{"type":"boolean","description":"Whether the promo rule is currently enabled."},"ends_at":{"$ref":"#/components/schemas/30EcommerceStoresStoreIdPromoRulesPromoRuleIdPatchRequestBodyContentApplicationJsonSchemaEndsAt"},"id":{"type":"string","pattern":"\\S","minLength":1,"maxLength":50,"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."},"starts_at":{"$ref":"#/components/schemas/30EcommerceStoresStoreIdPromoRulesPromoRuleIdPatchRequestBodyContentApplicationJsonSchemaStartsAt"},"target":{"$ref":"#/components/schemas/30EcommerceStoresStoreIdPromoRulesPromoRuleIdPatchRequestBodyContentApplicationJsonSchemaTarget","description":"The target that the discount applies to."},"title":{"type":"string","description":"The title that will show up in promotion campaign. Restricted to UTF-8 characters with max length of 100 bytes."},"type":{"$ref":"#/components/schemas/30EcommerceStoresStoreIdPromoRulesPromoRuleIdPatchRequestBodyContentApplicationJsonSchemaType","description":"Type of discount. For free shipping set type to fixed."},"updated_at_foreign":{"type":"string","description":"The date and time the promotion was updated in ISO 8601 format."}}}}}},"security":[{"bearerToken":[]}]},"delete":{"operationId":"ecommerce_delete-store-promo-rule","summary":"Delete promo rule","description":"Delete a promo rule from a store.","tags":["Ecommerce"],"parameters":[{"name":"store_id","in":"path","description":"The store id.","required":true,"schema":{"type":"string"}},{"name":"promo_rule_id","in":"path","description":"The id for the promo rule of a store.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Empty Response","content":{"application/json":{"schema":{"type":"object","properties":{}}}}}},"security":[{"bearerToken":[]}]}},"/3.0/ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}/promo-codes":{"get":{"operationId":"ecommerce_list-store-promo-rule-promo-codes","summary":"List promo codes","description":"Get information about a store's promo codes.","tags":["Ecommerce"],"parameters":[{"name":"promo_rule_id","in":"path","description":"The id for the promo rule of a store.","required":true,"schema":{"type":"string"}},{"name":"store_id","in":"path","description":"The store id.","required":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"count","in":"query","description":"The number of records to return. Default value is 10. Maximum value is 1000","required":false,"schema":{"type":"integer","maximum":1000,"default":10}},{"name":"offset","in":"query","description":"Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0.","required":false,"schema":{"type":"integer","default":0}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ecommerce_list-store-promo-rule-promo-codes_Response_200"}}}}},"security":[{"bearerToken":[]}]},"post":{"operationId":"ecommerce_create-store-promo-rule-promo-code","summary":"Add promo code","description":"Add a new promo code to a store.","tags":["Ecommerce"],"parameters":[{"name":"store_id","in":"path","description":"The store id.","required":true,"schema":{"type":"string"}},{"name":"promo_rule_id","in":"path","description":"The id for the promo rule of a store.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ECommercePromoCode"}}}}},"requestBody":{"description":"Information about an Ecommerce Store's specific Promo Code.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","description":"The discount code. Restricted to UTF-8 characters with max length 50."},"created_at_foreign":{"type":"string","description":"The date and time the promotion was created in ISO 8601 format."},"enabled":{"type":"boolean","description":"Whether the promo code is currently enabled."},"id":{"type":"string","pattern":"\\S","minLength":1,"maxLength":50,"description":"A unique identifier for the promo code. Restricted to UTF-8 characters with max length 50."},"redemption_url":{"type":"string","description":"The url that should be used in the promotion campaign restricted to UTF-8 characters with max length 2000."},"updated_at_foreign":{"type":"string","description":"The date and time the promotion was updated in ISO 8601 format."},"usage_count":{"type":"integer","description":"Number of times promo code has been used."}},"required":["code","id","redemption_url"]}}}},"security":[{"bearerToken":[]}]}},"/3.0/ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}/promo-codes/{promo_code_id}":{"get":{"operationId":"ecommerce_get-store-promo-rule-promo-code","summary":"Get promo code","description":"Get information about a specific promo code.","tags":["Ecommerce"],"parameters":[{"name":"store_id","in":"path","description":"The store id.","required":true,"schema":{"type":"string"}},{"name":"promo_rule_id","in":"path","description":"The id for the promo rule of a store.","required":true,"schema":{"type":"string"}},{"name":"promo_code_id","in":"path","description":"The id for the promo code of a store.","required":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ECommercePromoCode"}}}}},"security":[{"bearerToken":[]}]},"patch":{"operationId":"ecommerce_update-store-promo-rule-promo-code","summary":"Update promo code","description":"Update a promo code.","tags":["Ecommerce"],"parameters":[{"name":"store_id","in":"path","description":"The store id.","required":true,"schema":{"type":"string"}},{"name":"promo_rule_id","in":"path","description":"The id for the promo rule of a store.","required":true,"schema":{"type":"string"}},{"name":"promo_code_id","in":"path","description":"The id for the promo code of a store.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ECommercePromoCode"}}}}},"requestBody":{"description":"Information about an Ecommerce Store's specific Promo Code.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","description":"The discount code. Restricted to UTF-8 characters with max length 50."},"created_at_foreign":{"type":"string","description":"The date and time the promotion was created in ISO 8601 format."},"enabled":{"type":"boolean","description":"Whether the promo code is currently enabled."},"id":{"type":"string","pattern":"\\S","minLength":1,"maxLength":50,"description":"A unique identifier for the promo code. Restricted to UTF-8 characters with max length 50."},"redemption_url":{"type":"string","description":"The url that should be used in the promotion campaign restricted to UTF-8 characters with max length 2000."},"updated_at_foreign":{"type":"string","description":"The date and time the promotion was updated in ISO 8601 format."},"usage_count":{"type":"integer","description":"Number of times promo code has been used."}}}}}},"security":[{"bearerToken":[]}]},"delete":{"operationId":"ecommerce_delete-store-promo-rule-promo-code","summary":"Delete promo code","description":"Delete a promo code from a store.","tags":["Ecommerce"],"parameters":[{"name":"store_id","in":"path","description":"The store id.","required":true,"schema":{"type":"string"}},{"name":"promo_rule_id","in":"path","description":"The id for the promo rule of a store.","required":true,"schema":{"type":"string"}},{"name":"promo_code_id","in":"path","description":"The id for the promo code of a store.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Empty Response","content":{"application/json":{"schema":{"type":"object","properties":{}}}}}},"security":[{"bearerToken":[]}]}},"/3.0/facebook-ads":{"get":{"operationId":"facebookAds_list","summary":"List facebook ads","description":"Get list of Facebook ads.","tags":["facebookAds"],"parameters":[{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"count","in":"query","description":"The number of records to return. Default value is 10. Maximum value is 1000","required":false,"schema":{"type":"integer","maximum":1000,"default":10}},{"name":"offset","in":"query","description":"Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0.","required":false,"schema":{"type":"integer","default":0}},{"name":"sort_field","in":"query","description":"Returns files sorted by the specified field.","required":false,"schema":{"$ref":"#/components/schemas/30FacebookAdsGetParametersSortField"}},{"name":"sort_dir","in":"query","description":"Determines the order direction for sorted results.","required":false,"schema":{"$ref":"#/components/schemas/30FacebookAdsGetParametersSortDir"}}],"responses":{"200":{"description":"List of Facebook Ad Instances","content":{"application/json":{"schema":{"$ref":"#/components/schemas/facebook-ads_list_Response_200"}}}}},"security":[{"bearerToken":[]}]}},"/3.0/facebook-ads/{outreach_id}":{"get":{"operationId":"facebookAds_get","summary":"Get facebook ad info","description":"Get details of a Facebook ad.","tags":["facebookAds"],"parameters":[{"name":"outreach_id","in":"path","description":"The outreach id.","required":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Facebook Ad Instance","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FacebookAds"}}}}},"security":[{"bearerToken":[]}]}},"/3.0/file-manager":{"get":{"operationId":"fileManager_list","summary":"List file manager resources","description":"Get information about the file-manager endpoint's resources","tags":["fileManager"],"responses":{"200":{"description":"A file manager.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/30FileManagerGetResponsesContentApplicationJsonSchemaItems"}}}}}},"security":[{"bearerToken":[]}]}},"/3.0/file-manager/files":{"get":{"operationId":"fileManager_list-files","summary":"List stored files","description":"Get a list of available images and files stored in the File Manager for the account.","tags":["fileManager"],"parameters":[{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"count","in":"query","description":"The number of records to return. Default value is 10. Maximum value is 1000","required":false,"schema":{"type":"integer","maximum":1000,"default":10}},{"name":"offset","in":"query","description":"Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0.","required":false,"schema":{"type":"integer","default":0}},{"name":"type","in":"query","description":"The file type for the File Manager file.","required":false,"schema":{"type":"string"}},{"name":"created_by","in":"query","description":"The Mailchimp account user who created the File Manager file.","required":false,"schema":{"type":"string"}},{"name":"before_created_at","in":"query","description":"Restrict the response to files created before the set date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.","required":false,"schema":{"type":"string"}},{"name":"since_created_at","in":"query","description":"Restrict the response to files created after the set date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.","required":false,"schema":{"type":"string"}},{"name":"sort_field","in":"query","description":"Returns files sorted by the specified field.","required":false,"schema":{"$ref":"#/components/schemas/30FileManagerFilesGetParametersSortField"}},{"name":"sort_dir","in":"query","description":"Determines the order direction for sorted results.","required":false,"schema":{"$ref":"#/components/schemas/30FileManagerFilesGetParametersSortDir"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/file-manager_list-files_Response_200"}}}}},"security":[{"bearerToken":[]}]},"post":{"operationId":"fileManager_create-file","summary":"Add file","description":"Upload a new image or file to the File Manager.","tags":["fileManager"],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GalleryFile"}}}}},"requestBody":{"description":"An individual file listed in the File Manager.","content":{"application/json":{"schema":{"type":"object","properties":{"file_data":{"type":"string","description":"The base64-encoded contents of the file."},"folder_id":{"type":"integer","description":"The id of the folder."},"name":{"type":"string","description":"The name of the file."}},"required":["file_data","name"]}}}},"security":[{"bearerToken":[]}]}},"/3.0/file-manager/files/{file_id}":{"get":{"operationId":"fileManager_get-file","summary":"Get file","description":"Get information about a specific file in the File Manager.","tags":["fileManager"],"parameters":[{"name":"file_id","in":"path","description":"The unique id for the File Manager file.","required":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GalleryFile"}}}}},"security":[{"bearerToken":[]}]},"patch":{"operationId":"fileManager_update-file","summary":"Update file","description":"Update a file in the File Manager.","tags":["fileManager"],"parameters":[{"name":"file_id","in":"path","description":"The unique id for the File Manager file.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GalleryFile"}}}}},"requestBody":{"description":"An individual file listed in the File Manager.","content":{"application/json":{"schema":{"type":"object","properties":{"folder_id":{"type":"integer","description":"The id of the folder. Setting `folder_id` to `0` will remove a file from its current folder."},"name":{"type":"string","description":"The name of the file."}}}}}},"security":[{"bearerToken":[]}]},"delete":{"operationId":"fileManager_delete-file","summary":"Delete file","description":"Remove a specific file from the File Manager.","tags":["fileManager"],"parameters":[{"name":"file_id","in":"path","description":"The unique id for the File Manager file.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Empty Response","content":{"application/json":{"schema":{"type":"object","properties":{}}}}}},"security":[{"bearerToken":[]}]}},"/3.0/file-manager/folders":{"get":{"operationId":"fileManager_list-folders","summary":"List folders","description":"Get a list of all folders in the File Manager.","tags":["fileManager"],"parameters":[{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"count","in":"query","description":"The number of records to return. Default value is 10. Maximum value is 1000","required":false,"schema":{"type":"integer","maximum":1000,"default":10}},{"name":"offset","in":"query","description":"Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0.","required":false,"schema":{"type":"integer","default":0}},{"name":"created_by","in":"query","description":"The Mailchimp account user who created the File Manager file.","required":false,"schema":{"type":"string"}},{"name":"before_created_at","in":"query","description":"Restrict the response to files created before the set date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.","required":false,"schema":{"type":"string"}},{"name":"since_created_at","in":"query","description":"Restrict the response to files created after the set date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/file-manager_list-folders_Response_200"}}}}},"security":[{"bearerToken":[]}]},"post":{"operationId":"fileManager_create-folder","summary":"Add folder","description":"Create a new folder in the File Manager.","tags":["fileManager"],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/file-manager_create-folder_Response_200"}}}}},"requestBody":{"description":"An individual folder listed in the File Manager.","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"The name of the folder."}},"required":["name"]}}}},"security":[{"bearerToken":[]}]}},"/3.0/file-manager/folders/{folder_id}":{"get":{"operationId":"fileManager_get-folder","summary":"Get folder","description":"Get information about a specific folder in the File Manager.","tags":["fileManager"],"parameters":[{"name":"folder_id","in":"path","description":"The unique id for the File Manager folder.","required":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/file-manager_get-folder_Response_200"}}}}},"security":[{"bearerToken":[]}]},"patch":{"operationId":"fileManager_update-folder","summary":"Update folder","description":"Update a specific File Manager folder.","tags":["fileManager"],"parameters":[{"name":"folder_id","in":"path","description":"The unique id for the File Manager folder.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/file-manager_update-folder_Response_200"}}}}},"requestBody":{"description":"An individual folder listed in the File Manager.","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"The name of the folder."}},"required":["name"]}}}},"security":[{"bearerToken":[]}]},"delete":{"operationId":"fileManager_delete-folder","summary":"Delete folder","description":"Delete a specific folder in the File Manager.","tags":["fileManager"],"parameters":[{"name":"folder_id","in":"path","description":"The unique id for the File Manager folder.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Empty Response","content":{"application/json":{"schema":{"type":"object","properties":{}}}}}},"security":[{"bearerToken":[]}]}},"/3.0/file-manager/folders/{folder_id}/files":{"get":{"operationId":"fileManager_list-folder-files","summary":"List stored files","description":"Get a list of available images and files stored in this folder.","tags":["fileManager"],"parameters":[{"name":"folder_id","in":"path","description":"The unique id for the File Manager folder.","required":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"count","in":"query","description":"The number of records to return. Default value is 10. Maximum value is 1000","required":false,"schema":{"type":"integer","maximum":1000,"default":10}},{"name":"offset","in":"query","description":"Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0.","required":false,"schema":{"type":"integer","default":0}},{"name":"type","in":"query","description":"The file type for the File Manager file.","required":false,"schema":{"type":"string"}},{"name":"created_by","in":"query","description":"The Mailchimp account user who created the File Manager file.","required":false,"schema":{"type":"string"}},{"name":"before_created_at","in":"query","description":"Restrict the response to files created before the set date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.","required":false,"schema":{"type":"string"}},{"name":"since_created_at","in":"query","description":"Restrict the response to files created after the set date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.","required":false,"schema":{"type":"string"}},{"name":"sort_field","in":"query","description":"Returns files sorted by the specified field.","required":false,"schema":{"$ref":"#/components/schemas/30FileManagerFoldersFolderIdFilesGetParametersSortField"}},{"name":"sort_dir","in":"query","description":"Determines the order direction for sorted results.","required":false,"schema":{"$ref":"#/components/schemas/30FileManagerFoldersFolderIdFilesGetParametersSortDir"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/file-manager_list-folder-files_Response_200"}}}}},"security":[{"bearerToken":[]}]}},"/3.0/landing-pages":{"get":{"operationId":"landingPages_list","summary":"List landing pages","description":"Get all landing pages.","tags":["landingPages"],"parameters":[{"name":"sort_dir","in":"query","description":"Determines the order direction for sorted results.","required":false,"schema":{"$ref":"#/components/schemas/30LandingPagesGetParametersSortDir"}},{"name":"sort_field","in":"query","description":"Returns files sorted by the specified field.","required":false,"schema":{"$ref":"#/components/schemas/30LandingPagesGetParametersSortField"}},{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"count","in":"query","description":"The number of records to return. Default value is 10. Maximum value is 1000","required":false,"schema":{"type":"integer","maximum":1000,"default":10}}],"responses":{"200":{"description":"Landing Pages Collection","content":{"application/json":{"schema":{"$ref":"#/components/schemas/landing-pages_list_Response_200"}}}}},"security":[{"bearerToken":[]}]},"post":{"operationId":"landingPages_create","summary":"Add landing page","description":"Create an unpublished and contentless Mailchimp landing page.","tags":["landingPages"],"parameters":[{"name":"use_default_list","in":"query","description":"Will create the Landing Page using the account's Default List instead of requiring a list_id.","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LandingPage"}}}}},"requestBody":{"description":"A summary of an individual page's properties.","content":{"application/json":{"schema":{"type":"object","properties":{"description":{"type":"string","description":"The description of this landing page."},"list_id":{"type":"string","description":"The list's ID associated with this landing page."},"name":{"type":"string","description":"The name of this landing page."},"store_id":{"type":"string","description":"The ID of the store associated with this landing page."},"template_id":{"type":"integer","description":"The template_id of this landing page."},"title":{"type":"string","description":"The title of this landing page seen in the browser's title bar."},"tracking":{"$ref":"#/components/schemas/30LandingPagesPostRequestBodyContentApplicationJsonSchemaTracking","description":"The tracking settings applied to this landing page."},"type":{"$ref":"#/components/schemas/30LandingPagesPostRequestBodyContentApplicationJsonSchemaType","description":"The type of template the landing page has."}}}}}},"security":[{"bearerToken":[]}]}},"/3.0/landing-pages/{page_id}":{"get":{"operationId":"landingPages_get","summary":"Get landing page info","description":"Get information about a specific page.","tags":["landingPages"],"parameters":[{"name":"page_id","in":"path","description":"The unique id for the page.","required":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Landing Pages Instance","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LandingPage"}}}}},"security":[{"bearerToken":[]}]},"delete":{"operationId":"landingPages_delete","summary":"Delete landing page","description":"Delete a landing page.","tags":["landingPages"],"parameters":[{"name":"page_id","in":"path","description":"The unique id for the page.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Empty Response","content":{"application/json":{"schema":{"type":"object","properties":{}}}}}},"security":[{"bearerToken":[]}]},"patch":{"operationId":"landingPages_update","summary":"Update landing page","description":"Update a landing page.","tags":["landingPages"],"parameters":[{"name":"page_id","in":"path","description":"The unique id for the page.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LandingPage"}}}}},"requestBody":{"description":"A summary of an individual page's properties.","content":{"application/json":{"schema":{"type":"object","properties":{"description":{"type":"string","description":"The description of this landing page."},"list_id":{"type":"string","description":"The list's ID associated with this landing page."},"name":{"type":"string","description":"The name of this landing page."},"store_id":{"type":"string","description":"The ID of the store associated with this landing page."},"title":{"type":"string","description":"The title of this landing page seen in the browser's title bar."},"tracking":{"$ref":"#/components/schemas/30LandingPagesPageIdPatchRequestBodyContentApplicationJsonSchemaTracking","description":"The tracking settings applied to this landing page."}}}}}},"security":[{"bearerToken":[]}]}},"/3.0/landing-pages/{page_id}/actions/publish":{"post":{"operationId":"landingPages_create-action-publish","summary":"Publish landing page","description":"Publish a landing page that is in draft, unpublished, or has been previously published and edited.","tags":["landingPages"],"parameters":[{"name":"page_id","in":"path","description":"The unique id for the page.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Empty Response","content":{"application/json":{"schema":{"type":"object","properties":{}}}}}},"security":[{"bearerToken":[]}]}},"/3.0/landing-pages/{page_id}/actions/unpublish":{"post":{"operationId":"landingPages_create-action-unpublish","summary":"Unpublish landing page","description":"Unpublish a landing page that is in draft or has been published.","tags":["landingPages"],"parameters":[{"name":"page_id","in":"path","description":"The unique id for the page.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Empty Response","content":{"application/json":{"schema":{"type":"object","properties":{}}}}}},"security":[{"bearerToken":[]}]}},"/3.0/landing-pages/{page_id}/content":{"get":{"operationId":"landingPages_list-content","summary":"Get landing page content","description":"Get the the HTML for your landing page.","tags":["landingPages"],"parameters":[{"name":"page_id","in":"path","description":"The unique id for the page.","required":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/landing-pages_list-content_Response_200"}}}}},"security":[{"bearerToken":[]}]}},"/3.0/lists":{"get":{"operationId":"lists_list","summary":"Get lists info","description":"Get information about all lists in the account.","tags":["Lists"],"parameters":[{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"count","in":"query","description":"The number of records to return. Default value is 10. Maximum value is 1000","required":false,"schema":{"type":"integer","maximum":1000,"default":10}},{"name":"offset","in":"query","description":"Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0.","required":false,"schema":{"type":"integer","default":0}},{"name":"before_date_created","in":"query","description":"Restrict response to lists created before the set date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.","required":false,"schema":{"type":"string"}},{"name":"since_date_created","in":"query","description":"Restrict results to lists created after the set date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.","required":false,"schema":{"type":"string"}},{"name":"before_campaign_last_sent","in":"query","description":"Restrict results to lists created before the last campaign send date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.","required":false,"schema":{"type":"string"}},{"name":"since_campaign_last_sent","in":"query","description":"Restrict results to lists created after the last campaign send date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.","required":false,"schema":{"type":"string"}},{"name":"email","in":"query","description":"Restrict results to lists that include a specific subscriber's email address.","required":false,"schema":{"type":"string"}},{"name":"sort_field","in":"query","description":"Returns files sorted by the specified field.","required":false,"schema":{"$ref":"#/components/schemas/30ListsGetParametersSortField"}},{"name":"sort_dir","in":"query","description":"Determines the order direction for sorted results.","required":false,"schema":{"$ref":"#/components/schemas/30ListsGetParametersSortDir"}},{"name":"has_ecommerce_store","in":"query","description":"Restrict results to lists that contain an active, connected, undeleted ecommerce store.","required":false,"schema":{"type":"boolean"}},{"name":"include_total_contacts","in":"query","description":"Deprecated. Return the total_contacts field in the stats response, which contains an approximate count of subscribed, unsubscribed, and transactional contacts. For a complete audience contact count, use the /audiences endpoint instead.","required":false,"schema":{"type":"boolean"},"deprecated":true}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/lists_list_Response_200"}}}}},"security":[{"bearerToken":[]}]},"post":{"operationId":"lists_create","summary":"Add list","description":"Create a new list in your Mailchimp account.","tags":["Lists"],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriberList"}}}}},"requestBody":{"description":"Information about a specific list.","content":{"application/json":{"schema":{"type":"object","properties":{"campaign_defaults":{"$ref":"#/components/schemas/30ListsPostRequestBodyContentApplicationJsonSchemaCampaignDefaults","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."},"contact":{"$ref":"#/components/schemas/30ListsPostRequestBodyContentApplicationJsonSchemaContact","description":"[Contact information displayed in campaign footers](https://mailchimp.com/help/about-campaign-footers/) to comply with international spam laws."},"double_optin":{"type":"boolean","default":false,"description":"Whether or not to require the subscriber to confirm subscription via email."},"email_type_option":{"type":"boolean","description":"Whether the list supports [multiple formats for emails](https://mailchimp.com/help/audience-settings-and-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."},"marketing_permissions":{"type":"boolean","default":false,"description":"Whether or not the list has marketing permissions (eg. GDPR) enabled."},"name":{"type":"string","description":"The name of the list."},"notify_on_subscribe":{"type":"string","default":false,"description":"The email address to send [subscribe notifications](https://mailchimp.com/help/change-subscribe-and-unsubscribe-notifications/) to."},"notify_on_unsubscribe":{"type":"string","default":false,"description":"The email address to send [unsubscribe notifications](https://mailchimp.com/help/change-subscribe-and-unsubscribe-notifications/) to."},"permission_reminder":{"type":"string","description":"The [permission reminder](https://mailchimp.com/help/edit-the-permission-reminder/) for the list."},"use_archive_bar":{"type":"boolean","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."}},"required":["campaign_defaults","contact","email_type_option","name","permission_reminder"]}}}},"security":[{"bearerToken":[]}]}},"/3.0/lists/{list_id}":{"get":{"operationId":"lists_get","summary":"Get list info","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.","tags":["Lists"],"parameters":[{"name":"list_id","in":"path","description":"The unique ID for the list.","required":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"include_total_contacts","in":"query","description":"Deprecated. Return the total_contacts field in the stats response, which contains an approximate count of subscribed, unsubscribed, and transactional contacts. For a complete audience contact count, use the /audiences endpoint instead.","required":false,"schema":{"type":"boolean"},"deprecated":true}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriberList"}}}}},"security":[{"bearerToken":[]}]},"patch":{"operationId":"lists_update","summary":"Update lists","description":"Update the settings for a specific list.","tags":["Lists"],"parameters":[{"name":"list_id","in":"path","description":"The unique ID for the list.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriberList"}}}}},"requestBody":{"description":"Information about a specific list.","content":{"application/json":{"schema":{"type":"object","properties":{"campaign_defaults":{"$ref":"#/components/schemas/30ListsListIdPatchRequestBodyContentApplicationJsonSchemaCampaignDefaults","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."},"contact":{"$ref":"#/components/schemas/30ListsListIdPatchRequestBodyContentApplicationJsonSchemaContact","description":"[Contact information displayed in campaign footers](https://mailchimp.com/help/about-campaign-footers/) to comply with international spam laws."},"double_optin":{"type":"boolean","default":false,"description":"Whether or not to require the subscriber to confirm subscription via email."},"email_type_option":{"type":"boolean","description":"Whether the list supports [multiple formats for emails](https://mailchimp.com/help/audience-settings-and-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."},"marketing_permissions":{"type":"boolean","default":false,"description":"Whether or not the list has marketing permissions (eg. GDPR) enabled."},"name":{"type":"string","description":"The name of the list."},"notify_on_subscribe":{"type":"string","default":false,"description":"The email address to send [subscribe notifications](https://mailchimp.com/help/change-subscribe-and-unsubscribe-notifications/) to."},"notify_on_unsubscribe":{"type":"string","default":false,"description":"The email address to send [unsubscribe notifications](https://mailchimp.com/help/change-subscribe-and-unsubscribe-notifications/) to."},"permission_reminder":{"type":"string","description":"The [permission reminder](https://mailchimp.com/help/edit-the-permission-reminder/) for the list."},"use_archive_bar":{"type":"boolean","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."}}}}}},"security":[{"bearerToken":[]}]},"post":{"operationId":"lists_batch-subscribe-or-unsubscribe","summary":"Batch subscribe or unsubscribe","description":"Batch subscribe or unsubscribe list members.","tags":["Lists"],"parameters":[{"name":"list_id","in":"path","description":"The unique ID for the list.","required":true,"schema":{"type":"string"}},{"name":"skip_merge_validation","in":"query","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.","required":false,"schema":{"type":"boolean"}},{"name":"skip_duplicate_check","in":"query","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.","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/lists_batch-subscribe-or-unsubscribe_Response_200"}}}}},"requestBody":{"description":"Members to subscribe to or unsubscribe from a list.","content":{"application/json":{"schema":{"type":"object","properties":{"members":{"type":"array","items":{"$ref":"#/components/schemas/30ListsListIdPostRequestBodyContentApplicationJsonSchemaMembersItems"},"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."},"sync_tags":{"type":["boolean","null"],"description":"Whether this batch operation will replace all existing tags with tags in request."},"update_existing":{"type":["boolean","null"],"description":"Whether this batch operation will change existing members' subscription status."}},"required":["members"]}}}},"security":[{"bearerToken":[]}]},"delete":{"operationId":"lists_delete","summary":"Delete list","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.","tags":["Lists"],"parameters":[{"name":"list_id","in":"path","description":"The unique ID for the list.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Empty Response","content":{"application/json":{"schema":{"type":"object","properties":{}}}}}},"security":[{"bearerToken":[]}]}},"/3.0/lists/{list_id}/activity":{"get":{"operationId":"lists_list-activity","summary":"List recent activity","description":"Get up to the previous 180 days of daily detailed aggregated activity stats for a list, not including Automation activity.","tags":["Lists"],"parameters":[{"name":"list_id","in":"path","description":"The unique ID for the list.","required":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"count","in":"query","description":"The number of records to return. Default value is 10. Maximum value is 1000","required":false,"schema":{"type":"integer","maximum":1000,"default":10}},{"name":"offset","in":"query","description":"Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0.","required":false,"schema":{"type":"integer","default":0}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/lists_list-activity_Response_200"}}}}},"security":[{"bearerToken":[]}]}},"/3.0/lists/{list_id}/clients":{"get":{"operationId":"lists_list-clients","summary":"List top email clients","description":"Get a list of the top email clients based on user-agent strings.","tags":["Lists"],"parameters":[{"name":"list_id","in":"path","description":"The unique ID for the list.","required":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/lists_list-clients_Response_200"}}}}},"security":[{"bearerToken":[]}]}},"/3.0/lists/{list_id}/growth-history":{"get":{"operationId":"lists_list-growth-history","summary":"List growth history data","description":"Get a month-by-month summary of a specific list's growth activity.","tags":["Lists"],"parameters":[{"name":"list_id","in":"path","description":"The unique ID for the list.","required":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"count","in":"query","description":"The number of records to return. Default value is 10. Maximum value is 1000","required":false,"schema":{"type":"integer","maximum":1000,"default":10}},{"name":"offset","in":"query","description":"Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0.","required":false,"schema":{"type":"integer","default":0}},{"name":"sort_field","in":"query","description":"Returns files sorted by the specified field.","required":false,"schema":{"$ref":"#/components/schemas/30ListsListIdGrowthHistoryGetParametersSortField"}},{"name":"sort_dir","in":"query","description":"Determines the order direction for sorted results.","required":false,"schema":{"$ref":"#/components/schemas/30ListsListIdGrowthHistoryGetParametersSortDir"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/lists_list-growth-history_Response_200"}}}}},"security":[{"bearerToken":[]}]}},"/3.0/lists/{list_id}/growth-history/{month}":{"get":{"operationId":"lists_get-growth-history","summary":"Get growth history by month","description":"Get a summary of a specific list's growth activity for a specific month and year.","tags":["Lists"],"parameters":[{"name":"list_id","in":"path","description":"The unique ID for the list.","required":true,"schema":{"type":"string"}},{"name":"month","in":"path","description":"A specific month of list growth history.","required":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GrowthHistory"}}}}},"security":[{"bearerToken":[]}]}},"/3.0/lists/{list_id}/locations":{"get":{"operationId":"lists_list-locations","summary":"List locations","description":"Get the locations (countries) that the list's subscribers have been tagged to based on geocoding their IP address.","tags":["Lists"],"parameters":[{"name":"list_id","in":"path","description":"The unique ID for the list.","required":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/lists_list-locations_Response_200"}}}}},"security":[{"bearerToken":[]}]}},"/3.0/lists/{list_id}/tag-search":{"get":{"operationId":"lists_list-tag-search","summary":"Search for tags on a list by name.","description":"Search for tags on a list by name. If no name is provided, will return all tags on the list.","tags":["Lists"],"parameters":[{"name":"list_id","in":"path","description":"The unique ID for the list.","required":true,"schema":{"type":"string"}},{"name":"name","in":"query","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.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/lists_list-tag-search_Response_200"}}}}},"security":[{"bearerToken":[]}]}},"/3.0/lists/{list_id}/signup-forms":{"get":{"operationId":"lists_list-signup-forms","summary":"List signup forms","description":"Get signup forms for a specific list.","tags":["Lists"],"parameters":[{"name":"list_id","in":"path","description":"The unique ID for the list.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/lists_list-signup-forms_Response_200"}}}}},"security":[{"bearerToken":[]}]},"post":{"operationId":"lists_create-signup-form","summary":"Customize signup form","description":"Customize a list's default signup form.","tags":["Lists"],"parameters":[{"name":"list_id","in":"path","description":"The unique ID for the list.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignupForm"}}}}},"requestBody":{"description":"List signup form.","content":{"application/json":{"schema":{"type":"object","properties":{"contents":{"type":"array","items":{"$ref":"#/components/schemas/30ListsListIdSignupFormsPostRequestBodyContentApplicationJsonSchemaContentsItems"},"description":"The signup form body content."},"header":{"$ref":"#/components/schemas/30ListsListIdSignupFormsPostRequestBodyContentApplicationJsonSchemaHeader","description":"Options for customizing your signup form header."},"styles":{"type":"array","items":{"$ref":"#/components/schemas/30ListsListIdSignupFormsPostRequestBodyContentApplicationJsonSchemaStylesItems"},"description":"An array of objects, each representing an element style for the signup form."}}}}}},"security":[{"bearerToken":[]}]}},"/3.0/lists/{list_id}/abuse-reports":{"get":{"operationId":"lists_list-abuse-reports","summary":"List abuse reports","description":"Get all abuse reports for a specific list.","tags":["Lists"],"parameters":[{"name":"list_id","in":"path","description":"The unique ID for the list.","required":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"count","in":"query","description":"The number of records to return. Default value is 10. Maximum value is 1000","required":false,"schema":{"type":"integer","maximum":1000,"default":10}},{"name":"offset","in":"query","description":"Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0.","required":false,"schema":{"type":"integer","default":0}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/lists_list-abuse-reports_Response_200"}}}}},"security":[{"bearerToken":[]}]}},"/3.0/lists/{list_id}/abuse-reports/{report_id}":{"get":{"operationId":"lists_get-abuse-report","summary":"Get abuse report","description":"Get details about a specific abuse report.","tags":["Lists"],"parameters":[{"name":"list_id","in":"path","description":"The unique ID for the list.","required":true,"schema":{"type":"string"}},{"name":"report_id","in":"path","description":"The id for the abuse report.","required":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"count","in":"query","description":"The number of records to return. Default value is 10. Maximum value is 1000","required":false,"schema":{"type":"integer","maximum":1000,"default":10}},{"name":"offset","in":"query","description":"Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0.","required":false,"schema":{"type":"integer","default":0}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListsAbuseReports"}}}}},"security":[{"bearerToken":[]}]}},"/3.0/lists/{list_id}/interest-categories":{"get":{"operationId":"lists_list-interest-categories","summary":"List interest categories","description":"Get information about a list's interest categories.","tags":["Lists"],"parameters":[{"name":"list_id","in":"path","description":"The unique ID for the list.","required":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"count","in":"query","description":"The number of records to return. Default value is 10. Maximum value is 1000","required":false,"schema":{"type":"integer","maximum":1000,"default":10}},{"name":"offset","in":"query","description":"Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0.","required":false,"schema":{"type":"integer","default":0}},{"name":"type","in":"query","description":"Restrict results a type of interest group","required":false,"schema":{"type":"string"}},{"name":"sort_field","in":"query","description":"Returns interest categories sorted by the specified field. Defaults to display_order.","required":false,"schema":{"$ref":"#/components/schemas/30ListsListIdInterestCategoriesGetParametersSortField"}},{"name":"sort_dir","in":"query","description":"Determines the order direction for sorted results.","required":false,"schema":{"$ref":"#/components/schemas/30ListsListIdInterestCategoriesGetParametersSortDir"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/lists_list-interest-categories_Response_200"}}}}},"security":[{"bearerToken":[]}]},"post":{"operationId":"lists_create-interest-category","summary":"Add interest category","description":"Create a new interest category.","tags":["Lists"],"parameters":[{"name":"list_id","in":"path","description":"The unique ID for the list.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InterestCategory"}}}}},"requestBody":{"description":"Interest categories organize interests, which are used to group subscribers based on their preferences. These correspond to Group Titles the application.","content":{"application/json":{"schema":{"type":"object","properties":{"display_order":{"type":"integer","description":"The order that the categories are displayed in the list. Lower numbers display first."},"title":{"type":"string","description":"The text description of this category. This field appears on signup forms and is often phrased as a question."},"type":{"$ref":"#/components/schemas/30ListsListIdInterestCategoriesPostRequestBodyContentApplicationJsonSchemaType","description":"Determines how this category’s interests appear on signup forms."}},"required":["title","type"]}}}},"security":[{"bearerToken":[]}]}},"/3.0/lists/{list_id}/interest-categories/{interest_category_id}":{"get":{"operationId":"lists_get-interest-category","summary":"Get interest category info","description":"Get information about a specific interest category.","tags":["Lists"],"parameters":[{"name":"list_id","in":"path","description":"The unique ID for the list.","required":true,"schema":{"type":"string"}},{"name":"interest_category_id","in":"path","description":"The unique ID for the interest category.","required":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InterestCategory"}}}}},"security":[{"bearerToken":[]}]},"patch":{"operationId":"lists_update-interest-category","summary":"Update interest category","description":"Update a specific interest category.","tags":["Lists"],"parameters":[{"name":"list_id","in":"path","description":"The unique ID for the list.","required":true,"schema":{"type":"string"}},{"name":"interest_category_id","in":"path","description":"The unique ID for the interest category.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InterestCategory"}}}}},"requestBody":{"description":"Interest categories organize interests, which are used to group subscribers based on their preferences. These correspond to Group Titles the application.","content":{"application/json":{"schema":{"type":"object","properties":{"display_order":{"type":"integer","description":"The order that the categories are displayed in the list. Lower numbers display first."},"title":{"type":"string","description":"The text description of this category. This field appears on signup forms and is often phrased as a question."},"type":{"$ref":"#/components/schemas/30ListsListIdInterestCategoriesInterestCategoryIdPatchRequestBodyContentApplicationJsonSchemaType","description":"Determines how this category’s interests appear on signup forms."}}}}}},"security":[{"bearerToken":[]}]},"delete":{"operationId":"lists_delete-interest-category","summary":"Delete interest category","description":"Delete a specific interest category.","tags":["Lists"],"parameters":[{"name":"list_id","in":"path","description":"The unique ID for the list.","required":true,"schema":{"type":"string"}},{"name":"interest_category_id","in":"path","description":"The unique ID for the interest category.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Empty Response","content":{"application/json":{"schema":{"type":"object","properties":{}}}}}},"security":[{"bearerToken":[]}]}},"/3.0/lists/{list_id}/interest-categories/{interest_category_id}/interests":{"get":{"operationId":"lists_list-interest-category-interests","summary":"List interests in category","description":"Get a list of this category's interests.","tags":["Lists"],"parameters":[{"name":"list_id","in":"path","description":"The unique ID for the list.","required":true,"schema":{"type":"string"}},{"name":"interest_category_id","in":"path","description":"The unique ID for the interest category.","required":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"count","in":"query","description":"The number of records to return. Default value is 10. Maximum value is 1000","required":false,"schema":{"type":"integer","maximum":1000,"default":10}},{"name":"offset","in":"query","description":"Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0.","required":false,"schema":{"type":"integer","default":0}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/lists_list-interest-category-interests_Response_200"}}}}},"security":[{"bearerToken":[]}]},"post":{"operationId":"lists_create-interest-category-interest","summary":"Add interest in category","description":"Create a new interest or 'group name' for a specific category.","tags":["Lists"],"parameters":[{"name":"list_id","in":"path","description":"The unique ID for the list.","required":true,"schema":{"type":"string"}},{"name":"interest_category_id","in":"path","description":"The unique ID for the interest category.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Interest"}}}}},"requestBody":{"description":"Assign subscribers to interests to group them together. Interests are referred to as 'group names' in the Mailchimp application.","content":{"application/json":{"schema":{"type":"object","properties":{"display_order":{"type":"integer","description":"The display order for interests."},"name":{"type":"string","description":"The name of the interest. This can be shown publicly on a subscription form."}},"required":["name"]}}}},"security":[{"bearerToken":[]}]}},"/3.0/lists/{list_id}/interest-categories/{interest_category_id}/interests/{interest_id}":{"get":{"operationId":"lists_get-interest-category-interest","summary":"Get interest in category","description":"Get interests or 'group names' for a specific category.","tags":["Lists"],"parameters":[{"name":"list_id","in":"path","description":"The unique ID for the list.","required":true,"schema":{"type":"string"}},{"name":"interest_category_id","in":"path","description":"The unique ID for the interest category.","required":true,"schema":{"type":"string"}},{"name":"interest_id","in":"path","description":"The specific interest or 'group name'.","required":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Interest"}}}}},"security":[{"bearerToken":[]}]},"patch":{"operationId":"lists_update-interest-category-interest","summary":"Update interest in category","description":"Update interests or 'group names' for a specific category.","tags":["Lists"],"parameters":[{"name":"list_id","in":"path","description":"The unique ID for the list.","required":true,"schema":{"type":"string"}},{"name":"interest_category_id","in":"path","description":"The unique ID for the interest category.","required":true,"schema":{"type":"string"}},{"name":"interest_id","in":"path","description":"The specific interest or 'group name'.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Interest"}}}}},"requestBody":{"description":"Assign subscribers to interests to group them together. Interests are referred to as 'group names' in the Mailchimp application.","content":{"application/json":{"schema":{"type":"object","properties":{"display_order":{"type":"integer","description":"The display order for interests."},"name":{"type":"string","description":"The name of the interest. This can be shown publicly on a subscription form."}}}}}},"security":[{"bearerToken":[]}]},"delete":{"operationId":"lists_delete-interest-category-interest","summary":"Delete interest in category","description":"Delete interests or group names in a specific category.","tags":["Lists"],"parameters":[{"name":"list_id","in":"path","description":"The unique ID for the list.","required":true,"schema":{"type":"string"}},{"name":"interest_category_id","in":"path","description":"The unique ID for the interest category.","required":true,"schema":{"type":"string"}},{"name":"interest_id","in":"path","description":"The specific interest or 'group name'.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Empty Response","content":{"application/json":{"schema":{"type":"object","properties":{}}}}}},"security":[{"bearerToken":[]}]}},"/3.0/lists/{list_id}/members":{"get":{"operationId":"lists_list-members","summary":"List members info","description":"Get information about members in a specific Mailchimp list.","tags":["Lists"],"parameters":[{"name":"list_id","in":"path","description":"The unique ID for the list.","required":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"count","in":"query","description":"The number of records to return. Default value is 10. Maximum value is 1000","required":false,"schema":{"type":"integer","maximum":1000,"default":10}},{"name":"offset","in":"query","description":"Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0.","required":false,"schema":{"type":"integer","default":0}},{"name":"email_type","in":"query","description":"The email type.","required":false,"schema":{"type":"string"}},{"name":"status","in":"query","description":"The subscriber's status.","required":false,"schema":{"$ref":"#/components/schemas/30ListsListIdMembersGetParametersStatus"}},{"name":"since_timestamp_opt","in":"query","description":"Restrict results to subscribers who opted-in after the set timeframe. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.","required":false,"schema":{"type":"string"}},{"name":"before_timestamp_opt","in":"query","description":"Restrict results to subscribers who opted-in before the set timeframe. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.","required":false,"schema":{"type":"string"}},{"name":"since_last_changed","in":"query","description":"Restrict results to subscribers whose information changed after the set timeframe. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.","required":false,"schema":{"type":"string"}},{"name":"before_last_changed","in":"query","description":"Restrict results to subscribers whose information changed before the set timeframe. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.","required":false,"schema":{"type":"string"}},{"name":"unique_email_id","in":"query","description":"A unique identifier for the email address across all Mailchimp lists.","required":false,"schema":{"type":"string"}},{"name":"vip_only","in":"query","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.","required":false,"schema":{"type":"boolean"}},{"name":"interest_category_id","in":"query","description":"The unique id for the interest category.","required":false,"schema":{"type":"string"}},{"name":"interest_ids","in":"query","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.","required":false,"schema":{"type":"string"}},{"name":"interest_match","in":"query","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.","required":false,"schema":{"$ref":"#/components/schemas/30ListsListIdMembersGetParametersInterestMatch"}},{"name":"sort_field","in":"query","description":"Returns files sorted by the specified field.","required":false,"schema":{"$ref":"#/components/schemas/30ListsListIdMembersGetParametersSortField"}},{"name":"sort_dir","in":"query","description":"Determines the order direction for sorted results.","required":false,"schema":{"$ref":"#/components/schemas/30ListsListIdMembersGetParametersSortDir"}},{"name":"since_last_campaign","in":"query","description":"Filter subscribers by those subscribed/unsubscribed/pending/cleaned since last email campaign send. Member status is required to use this filter.","required":false,"schema":{"type":"boolean"}},{"name":"unsubscribed_since","in":"query","description":"Filter subscribers by those unsubscribed since a specific date. Using any status other than unsubscribed with this filter will result in an error.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/lists_list-members_Response_200"}}}}},"security":[{"bearerToken":[]}]},"post":{"operationId":"lists_create-member","summary":"Add member to list","description":"Add a new member to the list.","tags":["Lists"],"parameters":[{"name":"list_id","in":"path","description":"The unique ID for the list.","required":true,"schema":{"type":"string"}},{"name":"skip_merge_validation","in":"query","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.","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListMembers"}}}}},"requestBody":{"description":"Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed.","content":{"application/json":{"schema":{"type":"object","properties":{"email_address":{"type":"string","description":"Email address for a subscriber."},"email_type":{"type":"string","description":"Type of email this member asked to get ('html' or 'text')."},"interests":{"type":"object","additionalProperties":{"type":"boolean"},"description":"The key of this object's properties is the ID of the interest in question."},"ip_opt":{"type":"string","description":"The IP address the subscriber used to confirm their opt-in status."},"ip_signup":{"type":"string","description":"IP address the subscriber signed up from."},"language":{"type":"string","description":"If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/)."},"location":{"$ref":"#/components/schemas/30ListsListIdMembersPostRequestBodyContentApplicationJsonSchemaLocation","description":"Subscriber location information."},"marketing_permissions":{"type":"array","items":{"$ref":"#/components/schemas/30ListsListIdMembersPostRequestBodyContentApplicationJsonSchemaMarketingPermissionsItems"},"description":"The marketing permissions for the subscriber."},"merge_fields":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/30ListsListIdMembersPostRequestBodyContentApplicationJsonSchemaMergeFields"},"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."},"status":{"$ref":"#/components/schemas/30ListsListIdMembersPostRequestBodyContentApplicationJsonSchemaStatus","description":"Subscriber's current status."},"tags":{"type":"array","items":{"type":"string"},"description":"The tags that are associated with a member."},"timestamp_opt":{"$ref":"#/components/schemas/30ListsListIdMembersPostRequestBodyContentApplicationJsonSchemaTimestampOpt"},"timestamp_signup":{"$ref":"#/components/schemas/30ListsListIdMembersPostRequestBodyContentApplicationJsonSchemaTimestampSignup"},"vip":{"type":"boolean","description":"[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber."}},"required":["email_address","status"]}}}},"security":[{"bearerToken":[]}]}},"/3.0/lists/{list_id}/members/{subscriber_hash}":{"get":{"operationId":"lists_get-member","summary":"Get member info","description":"Get information about a specific list member, including a currently subscribed, unsubscribed, or bounced member.","tags":["Lists"],"parameters":[{"name":"list_id","in":"path","description":"The unique ID for the list.","required":true,"schema":{"type":"string"}},{"name":"subscriber_hash","in":"path","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.","required":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListMembers"}}}}},"security":[{"bearerToken":[]}]},"patch":{"operationId":"lists_update-member","summary":"Update list member","description":"Update information for a specific list member.","tags":["Lists"],"parameters":[{"name":"list_id","in":"path","description":"The unique ID for the list.","required":true,"schema":{"type":"string"}},{"name":"subscriber_hash","in":"path","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.","required":true,"schema":{"type":"string"}},{"name":"skip_merge_validation","in":"query","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.","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListMembers"}}}}},"requestBody":{"description":"Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed.","content":{"application/json":{"schema":{"type":"object","properties":{"email_address":{"type":"string","description":"Email address for a subscriber."},"email_type":{"type":"string","description":"Type of email this member asked to get ('html' or 'text')."},"interests":{"type":"object","additionalProperties":{"type":"boolean"},"description":"The key of this object's properties is the ID of the interest in question."},"ip_opt":{"type":"string","description":"The IP address the subscriber used to confirm their opt-in status."},"ip_signup":{"type":"string","description":"IP address the subscriber signed up from."},"language":{"type":"string","description":"If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/)."},"location":{"$ref":"#/components/schemas/30ListsListIdMembersSubscriberHashPatchRequestBodyContentApplicationJsonSchemaLocation","description":"Subscriber location information."},"marketing_permissions":{"type":"array","items":{"$ref":"#/components/schemas/30ListsListIdMembersSubscriberHashPatchRequestBodyContentApplicationJsonSchemaMarketingPermissionsItems"},"description":"The marketing permissions for the subscriber."},"merge_fields":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/30ListsListIdMembersSubscriberHashPatchRequestBodyContentApplicationJsonSchemaMergeFields"},"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."},"status":{"$ref":"#/components/schemas/30ListsListIdMembersSubscriberHashPatchRequestBodyContentApplicationJsonSchemaStatus","description":"Subscriber's current status."},"timestamp_opt":{"$ref":"#/components/schemas/30ListsListIdMembersSubscriberHashPatchRequestBodyContentApplicationJsonSchemaTimestampOpt"},"timestamp_signup":{"$ref":"#/components/schemas/30ListsListIdMembersSubscriberHashPatchRequestBodyContentApplicationJsonSchemaTimestampSignup"},"vip":{"type":"boolean","description":"[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber."}}}}}},"security":[{"bearerToken":[]}]},"put":{"operationId":"lists_upsert-member","summary":"Add or update list member","description":"Add or update a list member.","tags":["Lists"],"parameters":[{"name":"list_id","in":"path","description":"The unique ID for the list.","required":true,"schema":{"type":"string"}},{"name":"subscriber_hash","in":"path","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.","required":true,"schema":{"type":"string"}},{"name":"skip_merge_validation","in":"query","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.","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListMembers"}}}}},"requestBody":{"description":"Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed.","content":{"application/json":{"schema":{"type":"object","properties":{"email_address":{"type":"string","description":"Email address for a subscriber. This value is required only if the email address is not already present on the list."},"email_type":{"type":"string","description":"Type of email this member asked to get ('html' or 'text')."},"interests":{"type":"object","additionalProperties":{"type":"boolean"},"description":"The key of this object's properties is the ID of the interest in question."},"ip_opt":{"type":"string","description":"The IP address the subscriber used to confirm their opt-in status."},"ip_signup":{"type":"string","description":"IP address the subscriber signed up from."},"language":{"type":"string","description":"If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/)."},"location":{"$ref":"#/components/schemas/30ListsListIdMembersSubscriberHashPutRequestBodyContentApplicationJsonSchemaLocation","description":"Subscriber location information."},"marketing_permissions":{"type":"array","items":{"$ref":"#/components/schemas/30ListsListIdMembersSubscriberHashPutRequestBodyContentApplicationJsonSchemaMarketingPermissionsItems"},"description":"The marketing permissions for the subscriber."},"merge_fields":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/30ListsListIdMembersSubscriberHashPutRequestBodyContentApplicationJsonSchemaMergeFields"},"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."},"status":{"$ref":"#/components/schemas/30ListsListIdMembersSubscriberHashPutRequestBodyContentApplicationJsonSchemaStatus","description":"Subscriber's current status."},"status_if_new":{"$ref":"#/components/schemas/30ListsListIdMembersSubscriberHashPutRequestBodyContentApplicationJsonSchemaStatusIfNew","description":"Subscriber's status. This value is required only if the email address is not already present on the list."},"tags":{"type":"array","items":{"type":"string"},"description":"The tags that are associated with a member."},"timestamp_opt":{"$ref":"#/components/schemas/30ListsListIdMembersSubscriberHashPutRequestBodyContentApplicationJsonSchemaTimestampOpt"},"timestamp_signup":{"$ref":"#/components/schemas/30ListsListIdMembersSubscriberHashPutRequestBodyContentApplicationJsonSchemaTimestampSignup"},"vip":{"type":"boolean","description":"[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber."}},"required":["email_address"]}}}},"security":[{"bearerToken":[]}]},"delete":{"operationId":"lists_delete-member","summary":"Archive list member","description":"Archive a list member. To permanently delete, use the delete-permanent action.","tags":["Lists"],"parameters":[{"name":"list_id","in":"path","description":"The unique ID for the list.","required":true,"schema":{"type":"string"}},{"name":"subscriber_hash","in":"path","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.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Empty Response","content":{"application/json":{"schema":{"type":"object","properties":{}}}}}},"security":[{"bearerToken":[]}]}},"/3.0/lists/{list_id}/members/{subscriber_hash}/actions/delete-permanent":{"post":{"operationId":"lists_create-member-action-delete-permanent","summary":"Delete list member","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.","tags":["Lists"],"parameters":[{"name":"list_id","in":"path","description":"The unique ID for the list.","required":true,"schema":{"type":"string"}},{"name":"subscriber_hash","in":"path","description":"The MD5 hash of the lowercase version of the list member's email address.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Empty Response","content":{"application/json":{"schema":{"type":"object","properties":{}}}}}},"security":[{"bearerToken":[]}]}},"/3.0/lists/{list_id}/members/{subscriber_hash}/activity":{"get":{"operationId":"lists_list-member-activity","summary":"View recent activity 50","description":"Get the last 50 events of a member's activity on a specific list, including opens, clicks, and unsubscribes.","tags":["Lists"],"parameters":[{"name":"list_id","in":"path","description":"The unique ID for the list.","required":true,"schema":{"type":"string"}},{"name":"subscriber_hash","in":"path","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.","required":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"action","in":"query","description":"A comma seperated list of actions to return.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/30ListsListIdMembersSubscriberHashActivityGetParametersActionSchemaItems"}}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/lists_list-member-activity_Response_200"}}}}},"security":[{"bearerToken":[]}]}},"/3.0/lists/{list_id}/members/{subscriber_hash}/activity-feed":{"get":{"operationId":"lists_list-member-activity-feed","summary":"View recent activity","description":"Get a member's activity on a specific list, including opens, clicks, and unsubscribes.","tags":["Lists"],"parameters":[{"name":"list_id","in":"path","description":"The unique ID for the list.","required":true,"schema":{"type":"string"}},{"name":"subscriber_hash","in":"path","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.","required":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"count","in":"query","description":"The number of records to return. Default value is 10. Maximum value is 1000","required":false,"schema":{"type":"integer","maximum":1000,"default":10}},{"name":"offset","in":"query","description":"Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0.","required":false,"schema":{"type":"integer","default":0}},{"name":"activity_filters","in":"query","description":"A comma-separated list of activity filters that correspond to a set of activity types, e.g \"?activity_filters=open,bounce,click\".","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/30ListsListIdMembersSubscriberHashActivityFeedGetParametersActivityFiltersSchemaItems"}}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/lists_list-member-activity-feed_Response_200"}}}}},"security":[{"bearerToken":[]}]}},"/3.0/lists/{list_id}/members/{subscriber_hash}/events":{"get":{"operationId":"lists_list-member-events","summary":"List member events","description":"Get events for a contact.","tags":["Lists"],"parameters":[{"name":"list_id","in":"path","description":"The unique ID for the list.","required":true,"schema":{"type":"string"}},{"name":"subscriber_hash","in":"path","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.","required":true,"schema":{"type":"string"}},{"name":"count","in":"query","description":"The number of records to return. Default value is 10. Maximum value is 1000","required":false,"schema":{"type":"integer","maximum":1000,"default":10}},{"name":"offset","in":"query","description":"Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0.","required":false,"schema":{"type":"integer","default":0}},{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/lists_list-member-events_Response_200"}}}}},"security":[{"bearerToken":[]}]},"post":{"operationId":"lists_create-member-event","summary":"Add event","description":"Add an event for a list member.","tags":["Lists"],"parameters":[{"name":"list_id","in":"path","description":"The unique ID for the list.","required":true,"schema":{"type":"string"}},{"name":"subscriber_hash","in":"path","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.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Empty Response","content":{"application/json":{"schema":{"type":"object","properties":{}}}}}},"requestBody":{"description":"A new event for a specific list member","content":{"application/json":{"schema":{"type":"object","properties":{"is_syncing":{"type":"boolean","description":"Events created with the is_syncing value set to `true` will not trigger automations."},"name":{"type":"string","description":"The name for this type of event ('purchased', 'visited', etc). Must be 2-30 characters in length"},"occurred_at":{"type":"string","format":"date-time","description":"The date and time the event occurred in ISO 8601 format."},"properties":{"type":"object","additionalProperties":{"type":"string"},"description":"An optional list of properties"}},"required":["name"]}}}},"security":[{"bearerToken":[]}]}},"/3.0/lists/{list_id}/members/{subscriber_hash}/goals":{"get":{"operationId":"lists_list-member-goals","summary":"List member goal events","description":"Get the last 50 Goal events for a member on a specific list.","tags":["Lists"],"parameters":[{"name":"list_id","in":"path","description":"The unique ID for the list.","required":true,"schema":{"type":"string"}},{"name":"subscriber_hash","in":"path","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.","required":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/lists_list-member-goals_Response_200"}}}}},"security":[{"bearerToken":[]}]}},"/3.0/lists/{list_id}/members/{subscriber_hash}/notes":{"get":{"operationId":"lists_list-member-notes","summary":"List recent member notes","description":"Get recent notes for a specific list member.","tags":["Lists"],"parameters":[{"name":"list_id","in":"path","description":"The unique ID for the list.","required":true,"schema":{"type":"string"}},{"name":"subscriber_hash","in":"path","description":"The MD5 hash of the lowercase version of the list member's email address.","required":true,"schema":{"type":"string"}},{"name":"sort_field","in":"query","description":"Returns notes sorted by the specified field.","required":false,"schema":{"$ref":"#/components/schemas/30ListsListIdMembersSubscriberHashNotesGetParametersSortField"}},{"name":"sort_dir","in":"query","description":"Determines the order direction for sorted results.","required":false,"schema":{"$ref":"#/components/schemas/30ListsListIdMembersSubscriberHashNotesGetParametersSortDir"}},{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"count","in":"query","description":"The number of records to return. Default value is 10. Maximum value is 1000","required":false,"schema":{"type":"integer","maximum":1000,"default":10}},{"name":"offset","in":"query","description":"Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0.","required":false,"schema":{"type":"integer","default":0}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/lists_list-member-notes_Response_200"}}}}},"security":[{"bearerToken":[]}]},"post":{"operationId":"lists_create-member-note","summary":"Add member note","description":"Add a new note for a specific subscriber.","tags":["Lists"],"parameters":[{"name":"list_id","in":"path","description":"The unique ID for the list.","required":true,"schema":{"type":"string"}},{"name":"subscriber_hash","in":"path","description":"The MD5 hash of the lowercase version of the list member's email address.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MemberNotes"}}}}},"requestBody":{"description":"A specific note for a specific member.","content":{"application/json":{"schema":{"type":"object","properties":{"note":{"type":"string","description":"The content of the note. Note length is limited to 1,000 characters."}}}}}},"security":[{"bearerToken":[]}]}},"/3.0/lists/{list_id}/members/{subscriber_hash}/notes/{note_id}":{"get":{"operationId":"lists_get-member-note","summary":"Get member note","description":"Get a specific note for a specific list member.","tags":["Lists"],"parameters":[{"name":"list_id","in":"path","description":"The unique ID for the list.","required":true,"schema":{"type":"string"}},{"name":"subscriber_hash","in":"path","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.","required":true,"schema":{"type":"string"}},{"name":"note_id","in":"path","description":"The id for the note.","required":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MemberNotes"}}}}},"security":[{"bearerToken":[]}]},"patch":{"operationId":"lists_update-member-note","summary":"Update note","description":"Update a specific note for a specific list member.","tags":["Lists"],"parameters":[{"name":"list_id","in":"path","description":"The unique ID for the list.","required":true,"schema":{"type":"string"}},{"name":"subscriber_hash","in":"path","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.","required":true,"schema":{"type":"string"}},{"name":"note_id","in":"path","description":"The id for the note.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MemberNotes"}}}}},"requestBody":{"description":"A specific note for a specific member.","content":{"application/json":{"schema":{"type":"object","properties":{"note":{"type":"string","description":"The content of the note. Note length is limited to 1,000 characters."}}}}}},"security":[{"bearerToken":[]}]},"delete":{"operationId":"lists_delete-member-note","summary":"Delete note","description":"Delete a specific note for a specific list member.","tags":["Lists"],"parameters":[{"name":"list_id","in":"path","description":"The unique ID for the list.","required":true,"schema":{"type":"string"}},{"name":"subscriber_hash","in":"path","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.","required":true,"schema":{"type":"string"}},{"name":"note_id","in":"path","description":"The id for the note.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Empty Response","content":{"application/json":{"schema":{"type":"object","properties":{}}}}}},"security":[{"bearerToken":[]}]}},"/3.0/lists/{list_id}/members/{subscriber_hash}/tags":{"get":{"operationId":"lists_list-member-tags","summary":"List member tags","description":"Get the tags on a list member.","tags":["Lists"],"parameters":[{"name":"list_id","in":"path","description":"The unique ID for the list.","required":true,"schema":{"type":"string"}},{"name":"subscriber_hash","in":"path","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.","required":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"count","in":"query","description":"The number of records to return. Default value is 10. Maximum value is 1000","required":false,"schema":{"type":"integer","maximum":1000,"default":10}},{"name":"offset","in":"query","description":"Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0.","required":false,"schema":{"type":"integer","default":0}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/lists_list-member-tags_Response_200"}}}}},"security":[{"bearerToken":[]}]},"post":{"operationId":"lists_create-member-tag","summary":"Add or remove member tags","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.","tags":["Lists"],"parameters":[{"name":"list_id","in":"path","description":"The unique ID for the list.","required":true,"schema":{"type":"string"}},{"name":"subscriber_hash","in":"path","description":"The MD5 hash of the lowercase version of the list member's email address.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Empty Response","content":{"application/json":{"schema":{"type":"object","properties":{}}}}}},"requestBody":{"description":"A list of tags assigned to a list member.","content":{"application/json":{"schema":{"type":"object","properties":{"is_syncing":{"type":"boolean","description":"When is_syncing is true, automations based on the tags in the request will not fire"},"tags":{"type":"array","items":{"$ref":"#/components/schemas/30ListsListIdMembersSubscriberHashTagsPostRequestBodyContentApplicationJsonSchemaTagsItems"},"description":"A list of tags assigned to the list member."}},"required":["tags"]}}}},"security":[{"bearerToken":[]}]}},"/3.0/lists/{list_id}/merge-fields":{"get":{"operationId":"lists_list-merge-fields","summary":"List merge fields","description":"Get a list of all merge fields for an audience.","tags":["Lists"],"parameters":[{"name":"list_id","in":"path","description":"The unique ID for the list.","required":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"count","in":"query","description":"The number of records to return. Default value is 10. Maximum value is 1000","required":false,"schema":{"type":"integer","maximum":1000,"default":10}},{"name":"offset","in":"query","description":"Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0.","required":false,"schema":{"type":"integer","default":0}},{"name":"type","in":"query","description":"The merge field type.","required":false,"schema":{"type":"string"}},{"name":"required","in":"query","description":"Whether it's a required merge field.","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/lists_list-merge-fields_Response_200"}}}}},"security":[{"bearerToken":[]}]},"post":{"operationId":"lists_create-merge-field","summary":"Add merge field","description":"Add a new merge field for a specific audience.","tags":["Lists"],"parameters":[{"name":"list_id","in":"path","description":"The unique ID for the list.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MergeField"}}}}},"requestBody":{"description":"A [merge field](https://mailchimp.com/developer/marketing/docs/merge-fields/) for an audience.","content":{"application/json":{"schema":{"type":"object","properties":{"default_value":{"type":"string","description":"The default value for the merge field if `null`."},"display_order":{"type":"integer","description":"The order that the merge field displays on the list signup form."},"help_text":{"type":"string","description":"Extra text to help the subscriber fill out the form."},"name":{"type":"string","description":"The name of the merge field (audience field)."},"options":{"$ref":"#/components/schemas/30ListsListIdMergeFieldsPostRequestBodyContentApplicationJsonSchemaOptions","description":"Extra options for some merge field types."},"public":{"type":"boolean","description":"Whether the merge field is displayed on the signup form."},"required":{"type":"boolean","description":"Whether the merge field is required to import a contact."},"tag":{"type":"string","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)."},"type":{"$ref":"#/components/schemas/30ListsListIdMergeFieldsPostRequestBodyContentApplicationJsonSchemaType","description":"The [type](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for the merge field."}},"required":["name","type"]}}}},"security":[{"bearerToken":[]}]}},"/3.0/lists/{list_id}/merge-fields/{merge_id}":{"get":{"operationId":"lists_get-merge-field","summary":"Get merge field","description":"Get information about a specific merge field.","tags":["Lists"],"parameters":[{"name":"list_id","in":"path","description":"The unique ID for the list.","required":true,"schema":{"type":"string"}},{"name":"merge_id","in":"path","description":"The id for the merge field.","required":true,"schema":{"type":"string"}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MergeField"}}}}},"security":[{"bearerToken":[]}]},"patch":{"operationId":"lists_update-merge-field","summary":"Update merge field","description":"Update a specific merge field.","tags":["Lists"],"parameters":[{"name":"list_id","in":"path","description":"The unique ID for the list.","required":true,"schema":{"type":"string"}},{"name":"merge_id","in":"path","description":"The id for the merge field.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MergeField"}}}}},"requestBody":{"description":"A [merge field](https://mailchimp.com/developer/marketing/docs/merge-fields/) for an audience.","content":{"application/json":{"schema":{"type":"object","properties":{"default_value":{"type":"string","description":"The default value for the merge field if `null`."},"display_order":{"type":"integer","description":"The order that the merge field displays on the list signup form."},"help_text":{"type":"string","description":"Extra text to help the subscriber fill out the form."},"name":{"type":"string","description":"The name of the merge field (audience field)."},"options":{"$ref":"#/components/schemas/30ListsListIdMergeFieldsMergeIdPatchRequestBodyContentApplicationJsonSchemaOptions","description":"Extra options for some merge field types."},"public":{"type":"boolean","description":"Whether the merge field is displayed on the signup form."},"required":{"type":"boolean","description":"Whether the merge field is required to import a contact."},"tag":{"type":"string","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)."}}}}}},"security":[{"bearerToken":[]}]},"delete":{"operationId":"lists_delete-merge-field","summary":"Delete merge field","description":"Delete a specific merge field.","tags":["Lists"],"parameters":[{"name":"list_id","in":"path","description":"The unique ID for the list.","required":true,"schema":{"type":"string"}},{"name":"merge_id","in":"path","description":"The id for the merge field.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Empty Response","content":{"application/json":{"schema":{"type":"object","properties":{}}}}}},"security":[{"bearerToken":[]}]}},"/3.0/lists/{list_id}/segments":{"get":{"operationId":"lists_list-segments","summary":"List segments","description":"Get information about all available segments for a specific list.","tags":["Lists"],"parameters":[{"name":"list_id","in":"path","description":"The unique ID for the list.","required":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"count","in":"query","description":"The number of records to return. Default value is 10. Maximum value is 1000","required":false,"schema":{"type":"integer","maximum":1000,"default":10}},{"name":"offset","in":"query","description":"Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0.","required":false,"schema":{"type":"integer","default":0}},{"name":"type","in":"query","description":"Limit results based on segment type.","required":false,"schema":{"type":"string"}},{"name":"since_created_at","in":"query","description":"Restrict results to segments created after the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.","required":false,"schema":{"type":"string"}},{"name":"before_created_at","in":"query","description":"Restrict results to segments created before the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.","required":false,"schema":{"type":"string"}},{"name":"include_cleaned","in":"query","description":"Include cleaned members in response","required":false,"schema":{"type":"boolean"}},{"name":"include_transactional","in":"query","description":"Include transactional members in response","required":false,"schema":{"type":"boolean"}},{"name":"include_unsubscribed","in":"query","description":"Include unsubscribed members in response","required":false,"schema":{"type":"boolean"}},{"name":"since_updated_at","in":"query","description":"Restrict results to segments update after the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.","required":false,"schema":{"type":"string"}},{"name":"before_updated_at","in":"query","description":"Restrict results to segments update before the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.","required":false,"schema":{"type":"string"}},{"name":"exclude_type","in":"query","description":"Exclude results based on segment type. For example, use `exclude_type=static` to exclude tags from the response.","required":false,"schema":{"$ref":"#/components/schemas/30ListsListIdSegmentsGetParametersExcludeType"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/lists_list-segments_Response_200"}}}}},"security":[{"bearerToken":[]}]},"post":{"operationId":"lists_create-segment","summary":"Add segment","description":"Create a new segment in a specific list.","tags":["Lists"],"parameters":[{"name":"list_id","in":"path","description":"The unique ID for the list.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/List"}}}}},"requestBody":{"description":"Information about a specific list segment.","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"The name of the segment."},"options":{"$ref":"#/components/schemas/30ListsListIdSegmentsPostRequestBodyContentApplicationJsonSchemaOptions","description":"The [conditions of the segment](https://mailchimp.com/help/save-and-manage-segments/). Static and fuzzy segments don't have conditions."},"static_segment":{"type":"array","items":{"type":"string"},"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."}},"required":["name"]}}}},"security":[{"bearerToken":[]}]}},"/3.0/lists/{list_id}/segments/{segment_id}":{"get":{"operationId":"lists_get-segment","summary":"Get segment info","description":"Get information about a specific segment.","tags":["Lists"],"parameters":[{"name":"list_id","in":"path","description":"The unique ID for the list.","required":true,"schema":{"type":"string"}},{"name":"segment_id","in":"path","description":"The unique id for the segment.","required":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"include_cleaned","in":"query","description":"Include cleaned members in response","required":false,"schema":{"type":"boolean"}},{"name":"include_transactional","in":"query","description":"Include transactional members in response","required":false,"schema":{"type":"boolean"}},{"name":"include_unsubscribed","in":"query","description":"Include unsubscribed members in response","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/List"}}}}},"security":[{"bearerToken":[]}]},"patch":{"operationId":"lists_update-segment","summary":"Update segment","description":"Update a specific segment in a list.","tags":["Lists"],"parameters":[{"name":"list_id","in":"path","description":"The unique ID for the list.","required":true,"schema":{"type":"string"}},{"name":"segment_id","in":"path","description":"The unique id for the segment.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/List"}}}}},"requestBody":{"description":"Information about a specific list segment.","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"The name of the segment."},"options":{"$ref":"#/components/schemas/30ListsListIdSegmentsSegmentIdPatchRequestBodyContentApplicationJsonSchemaOptions","description":"The [conditions of the segment](https://mailchimp.com/help/save-and-manage-segments/). Static and fuzzy segments don't have conditions."},"static_segment":{"type":"array","items":{"type":"string"},"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."}}}}}},"security":[{"bearerToken":[]}]},"post":{"operationId":"lists_batch-add-or-remove-members","summary":"Batch add or remove members","description":"Batch add/remove list members to static segment","tags":["Lists"],"parameters":[{"name":"list_id","in":"path","description":"The unique ID for the list.","required":true,"schema":{"type":"string"}},{"name":"segment_id","in":"path","description":"The unique id for the segment.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/lists_batch-add-or-remove-members_Response_200"}}}}},"requestBody":{"description":"Members to add/remove to/from a static segment","content":{"application/json":{"schema":{"type":"object","properties":{"members_to_add":{"type":"array","items":{"type":"string"},"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."},"members_to_remove":{"type":"array","items":{"type":"string"},"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."}}}}}},"security":[{"bearerToken":[]}]},"delete":{"operationId":"lists_delete-segment","summary":"Delete segment","description":"Delete a specific segment in a list.","tags":["Lists"],"parameters":[{"name":"list_id","in":"path","description":"The unique ID for the list.","required":true,"schema":{"type":"string"}},{"name":"segment_id","in":"path","description":"The unique id for the segment.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Empty Response","content":{"application/json":{"schema":{"type":"object","properties":{}}}}}},"security":[{"bearerToken":[]}]}},"/3.0/lists/{list_id}/segments/{segment_id}/members":{"get":{"operationId":"lists_list-segment-members","summary":"List members in segment","description":"Get information about members in a saved segment.","tags":["Lists"],"parameters":[{"name":"list_id","in":"path","description":"The unique ID for the list.","required":true,"schema":{"type":"string"}},{"name":"segment_id","in":"path","description":"The unique id for the segment.","required":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"count","in":"query","description":"The number of records to return. Default value is 10. Maximum value is 1000","required":false,"schema":{"type":"integer","maximum":1000,"default":10}},{"name":"offset","in":"query","description":"Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0.","required":false,"schema":{"type":"integer","default":0}},{"name":"include_cleaned","in":"query","description":"Include cleaned members in response","required":false,"schema":{"type":"boolean"}},{"name":"include_transactional","in":"query","description":"Include transactional members in response","required":false,"schema":{"type":"boolean"}},{"name":"include_unsubscribed","in":"query","description":"Include unsubscribed members in response","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/lists_list-segment-members_Response_200"}}}}},"security":[{"bearerToken":[]}]},"post":{"operationId":"lists_create-segment-member","summary":"Add member to segment","description":"Add a member to a static segment.","tags":["Lists"],"parameters":[{"name":"list_id","in":"path","description":"The unique ID for the list.","required":true,"schema":{"type":"string"}},{"name":"segment_id","in":"path","description":"The unique id for the segment.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListsSegmentsMembers"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"email_address":{"type":"string","format":"email","description":"Email address for a subscriber."}},"required":["email_address"]}}}},"security":[{"bearerToken":[]}]}},"/3.0/lists/{list_id}/segments/{segment_id}/members/{subscriber_hash}":{"delete":{"operationId":"lists_delete-segment-member","summary":"Remove list member from segment","description":"Remove a member from the specified static segment.","tags":["Lists"],"parameters":[{"name":"list_id","in":"path","description":"The unique ID for the list.","required":true,"schema":{"type":"string"}},{"name":"segment_id","in":"path","description":"The unique id for the segment.","required":true,"schema":{"type":"string"}},{"name":"subscriber_hash","in":"path","description":"The MD5 hash of the lowercase version of the list member's email address.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Empty Response","content":{"application/json":{"schema":{"type":"object","properties":{}}}}}},"security":[{"bearerToken":[]}]}},"/3.0/lists/{list_id}/surveys":{"get":{"operationId":"lists_list-surveys","summary":"Get information about all surveys for a list","description":"Get information about all available surveys for a specific list.","tags":["Lists"],"parameters":[{"name":"list_id","in":"path","description":"The unique ID for the list.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/lists_list-surveys_Response_200"}}}}},"security":[{"bearerToken":[]}]},"post":{"operationId":"lists_create-survey","summary":"Create survey","description":"Create a draft survey for an audience.","tags":["Lists"],"parameters":[{"name":"list_id","in":"path","description":"The unique ID for the list.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Survey created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/lists_create-survey_Response_200"}}}}},"requestBody":{"description":"Create a draft survey for an audience.","content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string","description":"The title of the survey."},"sections":{"type":"array","items":{"$ref":"#/components/schemas/SurveySectionRequest"},"description":"Initial survey sections."}}}}}},"security":[{"bearerToken":[]}]}},"/3.0/lists/{list_id}/surveys/{survey_id}":{"get":{"operationId":"lists_get-survey","summary":"Get survey","description":"Get details about a specific survey.","tags":["Lists"],"parameters":[{"name":"list_id","in":"path","description":"The unique ID for the list.","required":true,"schema":{"type":"string"}},{"name":"survey_id","in":"path","description":"The ID of the survey.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/lists_get-survey_Response_200"}}}}},"security":[{"bearerToken":[]}]},"patch":{"operationId":"lists_update-survey","summary":"Update survey","description":"Update a survey. When sections is provided, send the complete section list in display order. Any existing section not included is deleted.","tags":["Lists"],"parameters":[{"name":"list_id","in":"path","description":"The unique ID for the list.","required":true,"schema":{"type":"string"}},{"name":"survey_id","in":"path","description":"The ID of the survey.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Survey updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/lists_update-survey_Response_200"}}}}},"requestBody":{"description":"Update a survey. When sections is provided, send the complete section list in display order. Any existing section not included is deleted.","content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string","description":"The title of the survey."},"is_piped_to_inbox":{"type":"boolean","description":"Whether responses are sent to Mailchimp Inbox."},"sections":{"type":"array","items":{"$ref":"#/components/schemas/SurveySectionRequest"},"description":"The complete survey section list in display order. On update, sections omitted from this array are deleted. Include section id to update an existing section; omit section id to add a new section."}}}}}},"security":[{"bearerToken":[]}]},"delete":{"operationId":"lists_delete-survey","summary":"Delete survey","description":"Delete a survey.","tags":["Lists"],"parameters":[{"name":"list_id","in":"path","description":"The unique ID for the list.","required":true,"schema":{"type":"string"}},{"name":"survey_id","in":"path","description":"The ID of the survey.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Survey deleted.","content":{"application/json":{"schema":{"type":"object","properties":{}}}}}},"security":[{"bearerToken":[]}]}},"/3.0/lists/{list_id}/surveys/{survey_id}/actions/create-email":{"post":{"operationId":"surveys_create-list-survey-action-create-email","summary":"Create a Survey Campaign","description":"Utilize the List ID and Survey ID to generate a Campaign that links to your survey.","tags":["Surveys"],"parameters":[{"name":"list_id","in":"path","description":"The unique ID for the list.","required":true,"schema":{"type":"string"}},{"name":"survey_id","in":"path","description":"The ID of the survey.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Campaign Instance","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Campaign"}}}}},"security":[{"bearerToken":[]}]}},"/3.0/lists/{list_id}/surveys/{survey_id}/actions/publish":{"post":{"operationId":"surveys_create-list-survey-action-publish","summary":"Publish a Survey","description":"Publish a survey that is in draft, unpublished, or has been previously published and edited.","tags":["Surveys"],"parameters":[{"name":"list_id","in":"path","description":"The unique ID for the list.","required":true,"schema":{"type":"string"}},{"name":"survey_id","in":"path","description":"The ID of the survey.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Survey Published","content":{"application/json":{"schema":{"$ref":"#/components/schemas/surveys_create-list-survey-action-publish_Response_200"}}}}},"security":[{"bearerToken":[]}]}},"/3.0/lists/{list_id}/surveys/{survey_id}/actions/replicate":{"post":{"operationId":"lists_create-list-survey-action-replicate","summary":"Replicate survey","description":"Replicate a survey.","tags":["Lists"],"parameters":[{"name":"list_id","in":"path","description":"The unique ID for the list.","required":true,"schema":{"type":"string"}},{"name":"survey_id","in":"path","description":"The ID of the survey.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Survey replicated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/lists_create-list-survey-action-replicate_Response_200"}}}}},"requestBody":{"description":"Replicate a survey.","content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string","description":"The title for the replicated survey."},"list_id":{"type":"string","description":"The unique ID of the audience for the replicated survey. Defaults to the source survey audience."}}}}}},"security":[{"bearerToken":[]}]}},"/3.0/lists/{list_id}/surveys/{survey_id}/actions/unpublish":{"post":{"operationId":"surveys_create-list-survey-action-unpublish","summary":"Unpublish a Survey","description":"Unpublish a survey that has been published.","tags":["Surveys"],"parameters":[{"name":"list_id","in":"path","description":"The unique ID for the list.","required":true,"schema":{"type":"string"}},{"name":"survey_id","in":"path","description":"The ID of the survey.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Survey Instance","content":{"application/json":{"schema":{"$ref":"#/components/schemas/surveys_create-list-survey-action-unpublish_Response_200"}}}}},"security":[{"bearerToken":[]}]}},"/3.0/lists/{list_id}/webhooks":{"get":{"operationId":"lists_list-webhooks","summary":"List webhooks","description":"Get information about all webhooks for a specific list.","tags":["Lists"],"parameters":[{"name":"list_id","in":"path","description":"The unique ID for the list.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/lists_list-webhooks_Response_200"}}}}},"security":[{"bearerToken":[]}]},"post":{"operationId":"lists_create-webhook","summary":"Add webhook","description":"Create a new webhook for a specific list.","tags":["Lists"],"parameters":[{"name":"list_id","in":"path","description":"The unique ID for the list.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/lists_create-webhook_Response_200"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddWebhook"}}}},"security":[{"bearerToken":[]}]}},"/3.0/lists/{list_id}/webhooks/{webhook_id}":{"get":{"operationId":"lists_get-webhook","summary":"Get webhook info","description":"Get information about a specific webhook.","tags":["Lists"],"parameters":[{"name":"list_id","in":"path","description":"The unique ID for the list.","required":true,"schema":{"type":"string"}},{"name":"webhook_id","in":"path","description":"The webhook's id.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListWebhooks"}}}}},"security":[{"bearerToken":[]}]},"patch":{"operationId":"lists_update-webhook","summary":"Update webhook","description":"Update the settings for an existing webhook.","tags":["Lists"],"parameters":[{"name":"list_id","in":"path","description":"The unique ID for the list.","required":true,"schema":{"type":"string"}},{"name":"webhook_id","in":"path","description":"The webhook's id.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListWebhooks"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddWebhook"}}}},"security":[{"bearerToken":[]}]},"delete":{"operationId":"lists_delete-webhook","summary":"Delete webhook","description":"Delete a specific webhook in a list.","tags":["Lists"],"parameters":[{"name":"list_id","in":"path","description":"The unique ID for the list.","required":true,"schema":{"type":"string"}},{"name":"webhook_id","in":"path","description":"The webhook's id.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Empty Response","content":{"application/json":{"schema":{"type":"object","properties":{}}}}}},"security":[{"bearerToken":[]}]}},"/3.0/ping":{"get":{"operationId":"ping_list","summary":"Ping","description":"A health check for the API that won't return any account-specific information.","tags":["Ping"],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ping_list_Response_200"}}}}},"security":[{"bearerToken":[]}]}},"/3.0/reporting":{"get":{"operationId":"reporting_list","summary":"List reporting resources","description":"Get information about the reporting endpoint's resources.","tags":["Reporting"],"responses":{"200":{"description":"Available resources under reporting endpoint","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/30ReportingGetResponsesContentApplicationJsonSchemaItems"}}}}}},"security":[{"bearerToken":[]}]}},"/3.0/reporting/facebook-ads":{"get":{"operationId":"reporting_list-facebook-ads","summary":"List facebook ads reports","description":"Get reports of Facebook ads.","tags":["Reporting"],"parameters":[{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"count","in":"query","description":"The number of records to return. Default value is 10. Maximum value is 1000","required":false,"schema":{"type":"integer","maximum":1000,"default":10}},{"name":"offset","in":"query","description":"Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0.","required":false,"schema":{"type":"integer","default":0}},{"name":"sort_field","in":"query","description":"Returns files sorted by the specified field.","required":false,"schema":{"$ref":"#/components/schemas/30ReportingFacebookAdsGetParametersSortField"}},{"name":"sort_dir","in":"query","description":"Determines the order direction for sorted results.","required":false,"schema":{"$ref":"#/components/schemas/30ReportingFacebookAdsGetParametersSortDir"}}],"responses":{"200":{"description":"List of Facebook Ad Report Instances","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reporting_list-facebook-ads_Response_200"}}}}},"security":[{"bearerToken":[]}]}},"/3.0/reporting/facebook-ads/{outreach_id}":{"get":{"operationId":"reporting_get-facebook-ad","summary":"Get facebook ad report","description":"Get report of a Facebook ad.","tags":["Reporting"],"parameters":[{"name":"outreach_id","in":"path","description":"The outreach id.","required":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Facebook Ad report Instance","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportingFacebookAd"}}}}},"security":[{"bearerToken":[]}]}},"/3.0/reporting/facebook-ads/{outreach_id}/ecommerce-product-activity":{"get":{"operationId":"reporting_list-facebook-ad-ecommerce-product-activity","summary":"List facebook ecommerce report","description":"Get breakdown of product activity for an outreach.","tags":["Reporting"],"parameters":[{"name":"outreach_id","in":"path","description":"The outreach id.","required":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"count","in":"query","description":"The number of records to return. Default value is 10. Maximum value is 1000","required":false,"schema":{"type":"integer","maximum":1000,"default":10}},{"name":"offset","in":"query","description":"Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0.","required":false,"schema":{"type":"integer","default":0}},{"name":"sort_field","in":"query","description":"Returns files sorted by the specified field.","required":false,"schema":{"$ref":"#/components/schemas/30ReportingFacebookAdsOutreachIdEcommerceProductActivityGetParametersSortField"}}],"responses":{"200":{"description":"Ecommerce Product Activity Instance","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reporting_list-facebook-ad-ecommerce-product-activity_Response_200"}}}}},"security":[{"bearerToken":[]}]}},"/3.0/reporting/landing-pages":{"get":{"operationId":"reporting_list-landing-pages","summary":"List landing pages reports","description":"Get reports of landing pages.","tags":["Reporting"],"parameters":[{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"count","in":"query","description":"The number of records to return. Default value is 10. Maximum value is 1000","required":false,"schema":{"type":"integer","maximum":1000,"default":10}},{"name":"offset","in":"query","description":"Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0.","required":false,"schema":{"type":"integer","default":0}}],"responses":{"200":{"description":"List of Landing Page Report Instances","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reporting_list-landing-pages_Response_200"}}}}},"security":[{"bearerToken":[]}]}},"/3.0/reporting/landing-pages/{outreach_id}":{"get":{"operationId":"reporting_get-landing-page","summary":"Get landing page report","description":"Get report of a landing page.","tags":["Reporting"],"parameters":[{"name":"outreach_id","in":"path","description":"The outreach id.","required":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Landing Page Report Instance","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LandingPageReport"}}}}},"security":[{"bearerToken":[]}]}},"/3.0/reporting/surveys":{"get":{"operationId":"reporting_list-surveys","summary":"List survey reports","description":"Get reports for surveys.","tags":["Reporting"],"parameters":[{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"count","in":"query","description":"The number of records to return. Default value is 10. Maximum value is 1000","required":false,"schema":{"type":"integer","maximum":1000,"default":10}},{"name":"offset","in":"query","description":"Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0.","required":false,"schema":{"type":"integer","default":0}}],"responses":{"200":{"description":"List of Survey Report Instances","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reporting_list-surveys_Response_200"}}}}},"security":[{"bearerToken":[]}]}},"/3.0/reporting/surveys/{survey_id}":{"get":{"operationId":"reporting_get-survey","summary":"Get survey report","description":"Get report for a survey.","tags":["Reporting"],"parameters":[{"name":"survey_id","in":"path","description":"The ID of the survey.","required":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Survey Report Instance","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reporting_get-survey_Response_200"}}}}},"security":[{"bearerToken":[]}]}},"/3.0/reporting/surveys/{survey_id}/questions":{"get":{"operationId":"reporting_list-survey-questions","summary":"List survey question reports","description":"Get reports for survey questions.","tags":["Reporting"],"parameters":[{"name":"survey_id","in":"path","description":"The ID of the survey.","required":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"List of Survey Question Report Instances","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reporting_list-survey-questions_Response_200"}}}}},"security":[{"bearerToken":[]}]}},"/3.0/reporting/surveys/{survey_id}/questions/{question_id}":{"get":{"operationId":"reporting_get-survey-question","summary":"Get survey question report","description":"Get report for a survey question.","tags":["Reporting"],"parameters":[{"name":"survey_id","in":"path","description":"The ID of the survey.","required":true,"schema":{"type":"string"}},{"name":"question_id","in":"path","description":"The ID of the survey question.","required":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Survey Question Report Instance","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SurveyQuestionReport"}}}}},"security":[{"bearerToken":[]}]}},"/3.0/reporting/surveys/{survey_id}/questions/{question_id}/answers":{"get":{"operationId":"reporting_list-survey-question-answers","summary":"List answers for question","description":"Get answers for a survey question.","tags":["Reporting"],"parameters":[{"name":"survey_id","in":"path","description":"The ID of the survey.","required":true,"schema":{"type":"string"}},{"name":"question_id","in":"path","description":"The ID of the survey question.","required":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"respondent_familiarity_is","in":"query","description":"Filter survey responses by familiarity of the respondents.","required":false,"schema":{"$ref":"#/components/schemas/30ReportingSurveysSurveyIdQuestionsQuestionIdAnswersGetParametersRespondentFamiliarityIs"}}],"responses":{"200":{"description":"List of Survey Question Answers","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reporting_list-survey-question-answers_Response_200"}}}}},"security":[{"bearerToken":[]}]}},"/3.0/reporting/surveys/{survey_id}/responses":{"get":{"operationId":"reporting_list-survey-responses","summary":"List survey responses","description":"Get responses to a survey.","tags":["Reporting"],"parameters":[{"name":"survey_id","in":"path","description":"The ID of the survey.","required":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"answered_question","in":"query","description":"The ID of the question that was answered.","required":false,"schema":{"type":"integer"}},{"name":"chose_answer","in":"query","description":"The ID of the option chosen to filter responses on.","required":false,"schema":{"type":"string"}},{"name":"respondent_familiarity_is","in":"query","description":"Filter survey responses by familiarity of the respondents.","required":false,"schema":{"$ref":"#/components/schemas/30ReportingSurveysSurveyIdResponsesGetParametersRespondentFamiliarityIs"}}],"responses":{"200":{"description":"List of survey responses","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reporting_list-survey-responses_Response_200"}}}}},"security":[{"bearerToken":[]}]}},"/3.0/reporting/surveys/{survey_id}/responses/{response_id}":{"get":{"operationId":"reporting_get-survey-respons","summary":"Get survey response","description":"Get a single survey response.","tags":["Reporting"],"parameters":[{"name":"survey_id","in":"path","description":"The ID of the survey.","required":true,"schema":{"type":"string"}},{"name":"response_id","in":"path","description":"The ID of the survey response.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Get a single survey response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reporting_get-survey-respons_Response_200"}}}}},"security":[{"bearerToken":[]}]}},"/3.0/reports":{"get":{"operationId":"reports_list","summary":"List campaign reports","description":"Get campaign reports.","tags":["Reports"],"parameters":[{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"count","in":"query","description":"The number of records to return. Default value is 10. Maximum value is 1000","required":false,"schema":{"type":"integer","maximum":1000,"default":10}},{"name":"offset","in":"query","description":"Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0.","required":false,"schema":{"type":"integer","default":0}},{"name":"type","in":"query","description":"The campaign type.","required":false,"schema":{"$ref":"#/components/schemas/30ReportsGetParametersType"}},{"name":"before_send_time","in":"query","description":"Restrict the response to campaigns sent before the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"since_send_time","in":"query","description":"Restrict the response to campaigns sent after the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.","required":false,"schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reports_list_Response_200"}}}}},"security":[{"bearerToken":[]}]}},"/3.0/reports/{campaign_id}":{"get":{"operationId":"reports_get","summary":"Get campaign report","description":"Get report details for a specific sent campaign.","tags":["Reports"],"parameters":[{"name":"campaign_id","in":"path","description":"The unique id for the campaign.","required":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignReport"}}}}},"security":[{"bearerToken":[]}]}},"/3.0/reports/{campaign_id}/abuse-reports":{"get":{"operationId":"reports_list-abuse-reports","summary":"List abuse reports","description":"Get a list of abuse complaints for a specific campaign.","tags":["Reports"],"parameters":[{"name":"campaign_id","in":"path","description":"The unique id for the campaign.","required":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reports_list-abuse-reports_Response_200"}}}}},"security":[{"bearerToken":[]}]}},"/3.0/reports/{campaign_id}/abuse-reports/{report_id}":{"get":{"operationId":"reports_get-abuse-report","summary":"Get abuse report","description":"Get information about a specific abuse report for a campaign.","tags":["Reports"],"parameters":[{"name":"campaign_id","in":"path","description":"The unique id for the campaign.","required":true,"schema":{"type":"string"}},{"name":"report_id","in":"path","description":"The id for the abuse report.","required":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AbuseComplaint"}}}}},"security":[{"bearerToken":[]}]}},"/3.0/reports/{campaign_id}/advice":{"get":{"operationId":"reports_list-advice","summary":"List campaign feedback","description":"Get feedback based on a campaign's statistics. Advice feedback is based on campaign stats like opens, clicks, unsubscribes, bounces, and more.","tags":["Reports"],"parameters":[{"name":"campaign_id","in":"path","description":"The unique id for the campaign.","required":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reports_list-advice_Response_200"}}}}},"security":[{"bearerToken":[]}]}},"/3.0/reports/{campaign_id}/click-details":{"get":{"operationId":"reports_list-click-details","summary":"List campaign details","description":"Get information about clicks on specific links in your Mailchimp campaigns.","tags":["Reports"],"parameters":[{"name":"campaign_id","in":"path","description":"The unique id for the campaign.","required":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"count","in":"query","description":"The number of records to return. Default value is 10. Maximum value is 1000","required":false,"schema":{"type":"integer","maximum":1000,"default":10}},{"name":"offset","in":"query","description":"Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0.","required":false,"schema":{"type":"integer","default":0}},{"name":"sort_field","in":"query","description":"Returns click reports sorted by the specified field.","required":false,"schema":{"$ref":"#/components/schemas/30ReportsCampaignIdClickDetailsGetParametersSortField"}},{"name":"sort_dir","in":"query","description":"Determines the order direction for sorted results.","required":false,"schema":{"$ref":"#/components/schemas/30ReportsCampaignIdClickDetailsGetParametersSortDir"}},{"name":"filter_bots","in":"query","description":"When true, exclude automated bot clicks so the returned click counts reflect human clicks only, matching the in-app Recipient Activity view. Filtering changes a link's counts, but never removes a link from the response. Defaults to false (all clicks).","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reports_list-click-details_Response_200"}}}}},"security":[{"bearerToken":[]}]}},"/3.0/reports/{campaign_id}/click-details/{link_id}":{"get":{"operationId":"reports_get-click-detail","summary":"Get campaign link details","description":"Get click details for a specific link in a campaign.","tags":["Reports"],"parameters":[{"name":"campaign_id","in":"path","description":"The unique id for the campaign.","required":true,"schema":{"type":"string"}},{"name":"link_id","in":"path","description":"The id for the link.","required":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"filter_bots","in":"query","description":"When true, exclude automated bot clicks so the returned click counts reflect human clicks only, matching the in-app Recipient Activity view. Filtering changes a link's counts, but never removes a link from the response. Defaults to false (all clicks).","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClickDetailReport"}}}}},"security":[{"bearerToken":[]}]}},"/3.0/reports/{campaign_id}/click-details/{link_id}/members":{"get":{"operationId":"reports_list-click-detail-members","summary":"List clicked link subscribers","description":"Get information about list members who clicked on a specific link in a campaign.","tags":["Reports"],"parameters":[{"name":"campaign_id","in":"path","description":"The unique id for the campaign.","required":true,"schema":{"type":"string"}},{"name":"link_id","in":"path","description":"The id for the link.","required":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"count","in":"query","description":"The number of records to return. Default value is 10. Maximum value is 1000","required":false,"schema":{"type":"integer","maximum":1000,"default":10}},{"name":"offset","in":"query","description":"Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0.","required":false,"schema":{"type":"integer","default":0}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reports_list-click-detail-members_Response_200"}}}}},"security":[{"bearerToken":[]}]}},"/3.0/reports/{campaign_id}/click-details/{link_id}/members/{subscriber_hash}":{"get":{"operationId":"reports_get-click-detail-member","summary":"Get clicked link subscriber","description":"Get information about a specific subscriber who clicked a link in a specific campaign.","tags":["Reports"],"parameters":[{"name":"campaign_id","in":"path","description":"The unique id for the campaign.","required":true,"schema":{"type":"string"}},{"name":"link_id","in":"path","description":"The id for the link.","required":true,"schema":{"type":"string"}},{"name":"subscriber_hash","in":"path","description":"The MD5 hash of the lowercase version of the list member's email address.","required":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClickDetailMember"}}}}},"security":[{"bearerToken":[]}]}},"/3.0/reports/{campaign_id}/domain-performance":{"get":{"operationId":"reports_list-domain-performance","summary":"List domain performance stats","description":"Get statistics for the top-performing email domains in a campaign.","tags":["Reports"],"parameters":[{"name":"campaign_id","in":"path","description":"The unique id for the campaign.","required":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reports_list-domain-performance_Response_200"}}}}},"security":[{"bearerToken":[]}]}},"/3.0/reports/{campaign_id}/ecommerce-product-activity":{"get":{"operationId":"reports_list-ecommerce-product-activity","summary":"List campaign product activity","description":"Get breakdown of product activity for a campaign","tags":["Reports"],"parameters":[{"name":"campaign_id","in":"path","description":"The unique id for the campaign.","required":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"count","in":"query","description":"The number of records to return. Default value is 10. Maximum value is 1000","required":false,"schema":{"type":"integer","maximum":1000,"default":10}},{"name":"offset","in":"query","description":"Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0.","required":false,"schema":{"type":"integer","default":0}},{"name":"sort_field","in":"query","description":"Returns files sorted by the specified field.","required":false,"schema":{"$ref":"#/components/schemas/30ReportsCampaignIdEcommerceProductActivityGetParametersSortField"}}],"responses":{"200":{"description":"Ecommerce Product Activity Instance","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reports_list-ecommerce-product-activity_Response_200"}}}}},"security":[{"bearerToken":[]}]}},"/3.0/reports/{campaign_id}/eepurl":{"get":{"operationId":"reports_list-eepurl","summary":"List EepURL activity","description":"Get a summary of social activity for the campaign, tracked by EepURL.","tags":["Reports"],"parameters":[{"name":"campaign_id","in":"path","description":"The unique id for the campaign.","required":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reports_list-eepurl_Response_200"}}}}},"security":[{"bearerToken":[]}]}},"/3.0/reports/{campaign_id}/email-activity":{"get":{"operationId":"reports_list-email-activity","summary":"List email activity","description":"Get a list of member's subscriber activity in a specific campaign.","tags":["Reports"],"parameters":[{"name":"campaign_id","in":"path","description":"The unique id for the campaign.","required":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"count","in":"query","description":"The number of records to return. Default value is 10. Maximum value is 1000","required":false,"schema":{"type":"integer","maximum":1000,"default":10}},{"name":"offset","in":"query","description":"Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0.","required":false,"schema":{"type":"integer","default":0}},{"name":"since","in":"query","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.","required":false,"schema":{"type":"string"}},{"name":"filter_bots","in":"query","description":"When true, exclude automated bot and Apple Mail Privacy Protection (MPP) proxy activity so the returned activity reflects human-only opens and clicks, matching the in-app Recipient Activity view. Filtering removes events from a member's activity, but never removes the member from the response. Defaults to false (all activity).","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reports_list-email-activity_Response_200"}}}}},"security":[{"bearerToken":[]}]}},"/3.0/reports/{campaign_id}/email-activity/{subscriber_hash}":{"get":{"operationId":"reports_get-email-activity","summary":"Get subscriber email activity","description":"Get a specific list member's activity in a campaign including opens, clicks, and bounces.","tags":["Reports"],"parameters":[{"name":"campaign_id","in":"path","description":"The unique id for the campaign.","required":true,"schema":{"type":"string"}},{"name":"subscriber_hash","in":"path","description":"The MD5 hash of the lowercase version of the list member's email address.","required":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"since","in":"query","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.","required":false,"schema":{"type":"string"}},{"name":"filter_bots","in":"query","description":"When true, exclude automated bot and Apple Mail Privacy Protection (MPP) proxy activity so the returned activity reflects human-only opens and clicks, matching the in-app Recipient Activity view. Filtering removes events from a member's activity, but never removes the member from the response. Defaults to false (all activity).","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailActivity"}}}}},"security":[{"bearerToken":[]}]}},"/3.0/reports/{campaign_id}/locations":{"get":{"operationId":"reports_list-locations","summary":"List top open activities","description":"Get top open locations for a specific campaign.","tags":["Reports"],"parameters":[{"name":"campaign_id","in":"path","description":"The unique id for the campaign.","required":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"count","in":"query","description":"The number of records to return. Default value is 10. Maximum value is 1000","required":false,"schema":{"type":"integer","maximum":1000,"default":10}},{"name":"offset","in":"query","description":"Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0.","required":false,"schema":{"type":"integer","default":0}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reports_list-locations_Response_200"}}}}},"security":[{"bearerToken":[]}]}},"/3.0/reports/{campaign_id}/open-details":{"get":{"operationId":"reports_list-open-details","summary":"List campaign open details","description":"Get detailed information about any campaign emails that were opened by a list member.","tags":["Reports"],"parameters":[{"name":"campaign_id","in":"path","description":"The unique id for the campaign.","required":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"count","in":"query","description":"The number of records to return. Default value is 10. Maximum value is 1000","required":false,"schema":{"type":"integer","maximum":1000,"default":10}},{"name":"offset","in":"query","description":"Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0.","required":false,"schema":{"type":"integer","default":0}},{"name":"since","in":"query","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.","required":false,"schema":{"type":"string"}},{"name":"sort_field","in":"query","description":"Returns open reports sorted by the specified field.","required":false,"schema":{"$ref":"#/components/schemas/30ReportsCampaignIdOpenDetailsGetParametersSortField"}},{"name":"sort_dir","in":"query","description":"Determines the order direction for sorted results.","required":false,"schema":{"$ref":"#/components/schemas/30ReportsCampaignIdOpenDetailsGetParametersSortDir"}},{"name":"filter_bots","in":"query","description":"When true, exclude automated (proxy/bot) opens so the returned open counts reflect human opens only, matching the in-app Recipient Activity view. A member whose opens are all automated is excluded from the human-only view. Defaults to false (all opens).","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reports_list-open-details_Response_200"}}}}},"security":[{"bearerToken":[]}]}},"/3.0/reports/{campaign_id}/open-details/{subscriber_hash}":{"get":{"operationId":"reports_get-open-detail","summary":"Get opened campaign subscriber","description":"Get information about a specific subscriber who opened a campaign.","tags":["Reports"],"parameters":[{"name":"campaign_id","in":"path","description":"The unique id for the campaign.","required":true,"schema":{"type":"string"}},{"name":"subscriber_hash","in":"path","description":"The MD5 hash of the lowercase version of the list member's email address.","required":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"filter_bots","in":"query","description":"When true, exclude automated (proxy/bot) opens so the returned open counts reflect human opens only, matching the in-app Recipient Activity view. A member whose opens are all automated is excluded from the human-only view. Defaults to false (all opens).","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenActivity"}}}}},"security":[{"bearerToken":[]}]}},"/3.0/reports/{campaign_id}/sent-to":{"get":{"operationId":"reports_list-sent-to","summary":"List campaign recipients","description":"Get information about campaign recipients.","tags":["Reports"],"parameters":[{"name":"campaign_id","in":"path","description":"The unique id for the campaign.","required":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"count","in":"query","description":"The number of records to return. Default value is 10. Maximum value is 1000","required":false,"schema":{"type":"integer","maximum":1000,"default":10}},{"name":"offset","in":"query","description":"Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0.","required":false,"schema":{"type":"integer","default":0}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reports_list-sent-to_Response_200"}}}}},"security":[{"bearerToken":[]}]}},"/3.0/reports/{campaign_id}/sent-to/{subscriber_hash}":{"get":{"operationId":"reports_get-sent-to","summary":"Get campaign recipient info","description":"Get information about a specific campaign recipient.","tags":["Reports"],"parameters":[{"name":"campaign_id","in":"path","description":"The unique id for the campaign.","required":true,"schema":{"type":"string"}},{"name":"subscriber_hash","in":"path","description":"The MD5 hash of the lowercase version of the list member's email address.","required":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SentTo"}}}}},"security":[{"bearerToken":[]}]}},"/3.0/reports/{campaign_id}/sub-reports":{"get":{"operationId":"reports_list-sub-reports","summary":"List child campaign reports","description":"Get a list of reports with child campaigns for a specific parent campaign.","tags":["Reports"],"parameters":[{"name":"campaign_id","in":"path","description":"The unique id for the campaign.","required":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reports_list-sub-reports_Response_200"}}}}},"security":[{"bearerToken":[]}]}},"/3.0/reports/{campaign_id}/unsubscribed":{"get":{"operationId":"reports_list-unsubscribed","summary":"List unsubscribed members","description":"Get information about members who have unsubscribed from a specific campaign.","tags":["Reports"],"parameters":[{"name":"campaign_id","in":"path","description":"The unique id for the campaign.","required":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"count","in":"query","description":"The number of records to return. Default value is 10. Maximum value is 1000","required":false,"schema":{"type":"integer","maximum":1000,"default":10}},{"name":"offset","in":"query","description":"Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0.","required":false,"schema":{"type":"integer","default":0}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reports_list-unsubscribed_Response_200"}}}}},"security":[{"bearerToken":[]}]}},"/3.0/reports/{campaign_id}/unsubscribed/{subscriber_hash}":{"get":{"operationId":"reports_get-unsubscribed","summary":"Get unsubscribed member","description":"Get information about a specific list member who unsubscribed from a campaign.","tags":["Reports"],"parameters":[{"name":"campaign_id","in":"path","description":"The unique id for the campaign.","required":true,"schema":{"type":"string"}},{"name":"subscriber_hash","in":"path","description":"The MD5 hash of the lowercase version of the list member's email address.","required":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Unsubscribes"}}}}},"security":[{"bearerToken":[]}]}},"/3.0/search-campaigns":{"get":{"operationId":"searchCampaigns_list","summary":"Search campaigns","description":"Search all campaigns for the specified query terms.","tags":["searchCampaigns"],"parameters":[{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"query","in":"query","description":"The search query used to filter results.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/search-campaigns_list_Response_200"}}}}},"security":[{"bearerToken":[]}]}},"/3.0/sms-campaigns":{"get":{"operationId":"smsCampaigns_list","summary":"List SMS campaigns","description":"Get all SMS campaigns in an account.","tags":["smsCampaigns"],"parameters":[{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"count","in":"query","description":"The number of records to return. Default value is 10. Maximum value is 1000","required":false,"schema":{"type":"integer","maximum":1000,"default":10}},{"name":"offset","in":"query","description":"Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0.","required":false,"schema":{"type":"integer","default":0}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sms-campaigns_list_Response_200"}}}}},"security":[{"bearerToken":[]}]},"post":{"operationId":"smsCampaigns_create","summary":"Add SMS campaign","description":"Create a new SMS campaign.","tags":["smsCampaigns"],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmsCampaign"}}}}},"requestBody":{"description":"The settings for creating a new SMS campaign.","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"The name of the campaign."},"list_id":{"type":"integer","description":"The numeric ID of the list to send the campaign to."},"folder_id":{"type":"string","description":"The ID of the folder to place this campaign in."},"segments":{"type":"array","items":{"type":"integer"},"description":"The segment IDs to target for this campaign."},"excluded_segments":{"type":"array","items":{"type":"integer"},"description":"The segment IDs to exclude from this campaign."}},"required":["name"]}}}},"security":[{"bearerToken":[]}]}},"/3.0/sms-campaigns/{sms_campaign_id}":{"get":{"operationId":"smsCampaigns_get","summary":"Get SMS campaign info","description":"Get the details for a single SMS campaign.","tags":["smsCampaigns"],"parameters":[{"name":"sms_campaign_id","in":"path","description":"The unique id for the SMS campaign.","required":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmsCampaign"}}}}},"security":[{"bearerToken":[]}]},"delete":{"operationId":"smsCampaigns_delete","summary":"Delete SMS campaign","description":"Remove a campaign from your Mailchimp account.","tags":["smsCampaigns"],"parameters":[{"name":"sms_campaign_id","in":"path","description":"The unique id for the SMS campaign.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Empty Response","content":{"application/json":{"schema":{"type":"object","properties":{}}}}}},"security":[{"bearerToken":[]}]},"patch":{"operationId":"smsCampaigns_update","summary":"Update an SMS campaign","description":"Update an SMS campaign.","tags":["smsCampaigns"],"parameters":[{"name":"sms_campaign_id","in":"path","description":"The unique id for the SMS campaign.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmsCampaign"}}}}},"requestBody":{"description":"The settings for updating an SMS campaign.","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"The name of the campaign."},"folder_id":{"type":"string","description":"The ID of the folder to place this campaign in."},"segments":{"type":"array","items":{"type":"integer"},"description":"The segment IDs to target for this campaign."},"excluded_segments":{"type":"array","items":{"type":"integer"},"description":"The segment IDs to exclude from this campaign."}}}}}},"security":[{"bearerToken":[]}]}},"/3.0/sms-campaigns/{sms_campaign_id}/actions/cancel-send":{"post":{"operationId":"smsCampaigns_create-action-cancel-send","summary":"Cancel SMS campaign send","description":"Cancel a scheduled or sending SMS campaign.","tags":["smsCampaigns"],"parameters":[{"name":"sms_campaign_id","in":"path","description":"The unique id for the SMS campaign.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Empty Response","content":{"application/json":{"schema":{"type":"object","properties":{}}}}}},"security":[{"bearerToken":[]}]}},"/3.0/sms-campaigns/{sms_campaign_id}/actions/schedule":{"post":{"operationId":"smsCampaigns_create-action-schedule","summary":"Schedule SMS campaign","description":"Schedule an SMS campaign for delivery.","tags":["smsCampaigns"],"parameters":[{"name":"sms_campaign_id","in":"path","description":"The unique id for the SMS campaign.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Empty Response","content":{"application/json":{"schema":{"type":"object","properties":{}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"schedule_time":{"type":"string","format":"date-time","description":"The UTC date and time to schedule the campaign."}},"required":["schedule_time"]}}}},"security":[{"bearerToken":[]}]}},"/3.0/sms-campaigns/{sms_campaign_id}/actions/send":{"post":{"operationId":"smsCampaigns_create-action-send","summary":"Send SMS campaign","description":"Send an SMS campaign.","tags":["smsCampaigns"],"parameters":[{"name":"sms_campaign_id","in":"path","description":"The unique id for the SMS campaign.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Empty Response","content":{"application/json":{"schema":{"type":"object","properties":{}}}}}},"security":[{"bearerToken":[]}]}},"/3.0/sms-campaigns/{sms_campaign_id}/content":{"get":{"operationId":"smsCampaigns_get-content","summary":"Get SMS campaign content","description":"Get the content for an SMS campaign.","tags":["smsCampaigns"],"parameters":[{"name":"sms_campaign_id","in":"path","description":"The unique id for the SMS campaign.","required":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmsCampaignContent"}}}}},"security":[{"bearerToken":[]}]},"put":{"operationId":"smsCampaigns_upsert-content","summary":"Set SMS campaign content","description":"Set the content for an SMS campaign.","tags":["smsCampaigns"],"parameters":[{"name":"sms_campaign_id","in":"path","description":"The unique id for the SMS campaign.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmsCampaignContent"}}}}},"requestBody":{"description":"The settings for setting the content of an SMS campaign.","content":{"application/json":{"schema":{"type":"object","properties":{"message_body":{"type":"string","description":"The SMS message body."},"media":{"type":"array","items":{"$ref":"#/components/schemas/30SmsCampaignsSmsCampaignIdContentPutRequestBodyContentApplicationJsonSchemaMediaItems"},"description":"Attached images or files. Limited to one item. Omitting this field or sending an empty array removes any existing media; to keep the current media while updating other fields, re-send the media array."}},"required":["message_body"]}}}},"security":[{"bearerToken":[]}]}},"/3.0/search-members":{"get":{"operationId":"searchMembers_list","summary":"Search members","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.","tags":["searchMembers"],"parameters":[{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"query","in":"query","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.","required":true,"schema":{"type":"string"}},{"name":"list_id","in":"query","description":"The unique id for the list.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/search-members_list_Response_200"}}}}},"security":[{"bearerToken":[]}]}},"/3.0/template-folders":{"get":{"operationId":"templateFolders_list","summary":"List template folders","description":"Get all folders used to organize templates.","tags":["templateFolders"],"parameters":[{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"count","in":"query","description":"The number of records to return. Default value is 10. Maximum value is 1000","required":false,"schema":{"type":"integer","maximum":1000,"default":10}},{"name":"offset","in":"query","description":"Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0.","required":false,"schema":{"type":"integer","default":0}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/template-folders_list_Response_200"}}}}},"security":[{"bearerToken":[]}]},"post":{"operationId":"templateFolders_create","summary":"Add template folder","description":"Create a new template folder.","tags":["templateFolders"],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/template-folders_create_Response_200"}}}}},"requestBody":{"description":"A folder used to organize templates.","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"The name of the folder."}},"required":["name"]}}}},"security":[{"bearerToken":[]}]}},"/3.0/template-folders/{folder_id}":{"get":{"operationId":"templateFolders_get","summary":"Get template folder","description":"Get information about a specific folder used to organize templates.","tags":["templateFolders"],"parameters":[{"name":"folder_id","in":"path","description":"The unique id for the template folder.","required":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/template-folders_get_Response_200"}}}}},"security":[{"bearerToken":[]}]},"delete":{"operationId":"templateFolders_delete","summary":"Delete template folder","description":"Delete a specific template folder, and mark all the templates in the folder as 'unfiled'.","tags":["templateFolders"],"parameters":[{"name":"folder_id","in":"path","description":"The unique id for the template folder.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Empty Response","content":{"application/json":{"schema":{"type":"object","properties":{}}}}}},"security":[{"bearerToken":[]}]},"patch":{"operationId":"templateFolders_update","summary":"Update template folder","description":"Update a specific folder used to organize templates.","tags":["templateFolders"],"parameters":[{"name":"folder_id","in":"path","description":"The unique id for the template folder.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/template-folders_update_Response_200"}}}}},"requestBody":{"description":"A folder used to organize templates.","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"The name of the folder."}},"required":["name"]}}}},"security":[{"bearerToken":[]}]}},"/3.0/templates":{"get":{"operationId":"templates_list","summary":"List templates","description":"Get a list of an account's available templates.","tags":["Templates"],"parameters":[{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"count","in":"query","description":"The number of records to return. Default value is 10. Maximum value is 1000","required":false,"schema":{"type":"integer","maximum":1000,"default":10}},{"name":"offset","in":"query","description":"Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0.","required":false,"schema":{"type":"integer","default":0}},{"name":"created_by","in":"query","description":"The Mailchimp account user who created the template.","required":false,"schema":{"type":"string"}},{"name":"since_date_created","in":"query","description":"Restrict the response to templates created after the set date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.","required":false,"schema":{"type":"string"}},{"name":"before_date_created","in":"query","description":"Restrict the response to templates created before the set date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.","required":false,"schema":{"type":"string"}},{"name":"type","in":"query","description":"Limit results based on template type.","required":false,"schema":{"type":"string"}},{"name":"category","in":"query","description":"Limit results based on category.","required":false,"schema":{"type":"string"}},{"name":"folder_id","in":"query","description":"The unique folder id.","required":false,"schema":{"type":"string"}},{"name":"sort_field","in":"query","description":"Returns user templates sorted by the specified field.","required":false,"schema":{"$ref":"#/components/schemas/30TemplatesGetParametersSortField"}},{"name":"content_type","in":"query","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`.","required":false,"schema":{"$ref":"#/components/schemas/30TemplatesGetParametersContentType"}},{"name":"sort_dir","in":"query","description":"Determines the order direction for sorted results.","required":false,"schema":{"$ref":"#/components/schemas/30TemplatesGetParametersSortDir"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/templates_list_Response_200"}}}}},"security":[{"bearerToken":[]}]},"post":{"operationId":"templates_create","summary":"Add template","description":"Create a new template for the account. Only Classic templates are supported.","tags":["Templates"],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TemplateInstance"}}}}},"requestBody":{"description":"Information about a specific template.","content":{"application/json":{"schema":{"type":"object","properties":{"folder_id":{"type":"string","description":"The id of the folder the template is currently in."},"html":{"$ref":"#/components/schemas/30TemplatesPostRequestBodyContentApplicationJsonSchemaHtml","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."},"name":{"type":"string","description":"The name of the template."}},"required":["html","name"]}}}},"security":[{"bearerToken":[]}]}},"/3.0/templates/{template_id}":{"get":{"operationId":"templates_get","summary":"Get template info","description":"Get information about a specific template.","tags":["Templates"],"parameters":[{"name":"template_id","in":"path","description":"The unique id for the template.","required":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TemplateInstance"}}}}},"security":[{"bearerToken":[]}]},"delete":{"operationId":"templates_delete","summary":"Delete template","description":"Delete a specific template.","tags":["Templates"],"parameters":[{"name":"template_id","in":"path","description":"The unique id for the template.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Empty Response","content":{"application/json":{"schema":{"type":"object","properties":{}}}}}},"security":[{"bearerToken":[]}]},"patch":{"operationId":"templates_update","summary":"Update template","description":"Update the name, HTML, or `folder_id` of an existing template.","tags":["Templates"],"parameters":[{"name":"template_id","in":"path","description":"The unique id for the template.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TemplateInstance"}}}}},"requestBody":{"description":"Information about a specific template.","content":{"application/json":{"schema":{"type":"object","properties":{"folder_id":{"type":"string","description":"The id of the folder the template is currently in."},"html":{"type":"string","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."},"name":{"type":"string","description":"The name of the template."}}}}}},"security":[{"bearerToken":[]}]}},"/3.0/templates/{template_id}/default-content":{"get":{"operationId":"templates_list-default-content","summary":"View default content","description":"Get the sections that you can edit in a template, including each section's default content.","tags":["Templates"],"parameters":[{"name":"template_id","in":"path","description":"The unique id for the template.","required":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"exclude_fields","in":"query","description":"A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/templates_list-default-content_Response_200"}}}}},"security":[{"bearerToken":[]}]}},"/3.0/verified-domains":{"get":{"operationId":"verifiedDomains_list","summary":"List sending domains","description":"Get all of the sending domains on the account.","tags":["verifiedDomains"],"responses":{"200":{"description":"The domains on the account.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/verified-domains_list_Response_200"}}}}},"security":[{"bearerToken":[]}]},"post":{"operationId":"verifiedDomains_create","summary":"Add domain to account","description":"Add a domain to the account.","tags":["verifiedDomains"],"responses":{"200":{"description":"The newly-created domain.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/verified-domains_create_Response_200"}}}}},"requestBody":{"description":"The verified domains currently on the account.","content":{"application/json":{"schema":{"type":"object","properties":{"verification_email":{"type":"string","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."}},"required":["verification_email"]}}}},"security":[{"bearerToken":[]}]}},"/3.0/verified-domains/{domain_name}":{"get":{"operationId":"verifiedDomains_get","summary":"Get domain info","description":"Get the details for a single domain on the account.","tags":["verifiedDomains"],"parameters":[{"name":"domain_name","in":"path","description":"The domain name.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/verified-domains_get_Response_200"}}}}},"security":[{"bearerToken":[]}]},"delete":{"operationId":"verifiedDomains_delete","summary":"Delete domain","description":"Delete a verified domain from the account.","tags":["verifiedDomains"],"parameters":[{"name":"domain_name","in":"path","description":"The domain name.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Empty Response","content":{"application/json":{"schema":{"type":"object","properties":{}}}}}},"security":[{"bearerToken":[]}]}},"/3.0/verified-domains/{domain_name}/actions/verify":{"post":{"operationId":"verifiedDomains_create-action-verify","summary":"Verify domain","description":"Verify a domain for sending.","tags":["verifiedDomains"],"parameters":[{"name":"domain_name","in":"path","description":"The domain name.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The domain being verified for sending.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/verified-domains_create-action-verify_Response_200"}}}}},"requestBody":{"description":"Submit a response to the verification challenge and verify a domain for sending.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","description":"The code that was sent to the email address provided when adding a new domain to verify."}},"required":["code"]}}}},"security":[{"bearerToken":[]}]}}},"tags":[{"name":"Root"},{"name":"accountExports"},{"name":"activityFeed"},{"name":"audiences"},{"name":"authorizedApps"},{"name":"Automations"},{"name":"batchWebhooks"},{"name":"Batches"},{"name":"campaignFolders"},{"name":"Campaigns"},{"name":"connectedSites"},{"name":"Conversations"},{"name":"customerJourneys"},{"name":"Ecommerce"},{"name":"facebookAds"},{"name":"fileManager"},{"name":"landingPages"},{"name":"Lists"},{"name":"Surveys"},{"name":"Ping"},{"name":"Reporting"},{"name":"Reports"},{"name":"searchCampaigns"},{"name":"smsCampaigns"},{"name":"searchMembers"},{"name":"templateFolders"},{"name":"Templates"},{"name":"verifiedDomains"}],"servers":[{"url":"https://api.mailchimp.com","description":"Mailchimp public API"}],"components":{"schemas":{"30GetResponsesContentApplicationJsonSchemaLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"30GetResponsesContentApplicationJsonSchemaLinksItemsMethod"},"30GetResponsesContentApplicationJsonSchemaLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/30GetResponsesContentApplicationJsonSchemaLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"30GetResponsesContentApplicationJsonSchemaLinksItems"},"30GetResponsesContentApplicationJsonSchemaContact":{"type":"object","properties":{"addr1":{"type":"string","description":"The street address for the account contact."},"addr2":{"type":"string","description":"The street address for the account contact."},"city":{"type":"string","description":"The city for the account contact."},"company":{"type":"string","description":"The company name for the account."},"country":{"type":"string","description":"The country for the account contact."},"state":{"type":"string","description":"The state for the account contact."},"zip":{"type":"string","description":"The zip code for the account contact."}},"description":"Information about the account contact.","title":"30GetResponsesContentApplicationJsonSchemaContact"},"30GetResponsesContentApplicationJsonSchemaFirstPayment":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","enum":[""]}],"description":"Date of first payment for monthly plans.","title":"30GetResponsesContentApplicationJsonSchemaFirstPayment"},"30GetResponsesContentApplicationJsonSchemaIndustryStats":{"type":"object","properties":{"bounce_rate":{"type":"number","format":"double","description":"The average bounce rate for all campaigns in the account's specified industry."},"click_rate":{"type":"number","format":"double","description":"The average unique click rate for all campaigns in the account's specified industry."},"open_rate":{"type":"number","format":"double","description":"The average unique open rate for all campaigns in the account's specified industry."}},"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.","title":"30GetResponsesContentApplicationJsonSchemaIndustryStats"},"30GetResponsesContentApplicationJsonSchemaPricingPlanType":{"type":"string","enum":["monthly","pay_as_you_go","forever_free"],"description":"The type of pricing plan the account is on.","title":"30GetResponsesContentApplicationJsonSchemaPricingPlanType"},"root_list_Response_200":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/30GetResponsesContentApplicationJsonSchemaLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"account_id":{"type":"string","description":"The Mailchimp account ID."},"account_industry":{"type":"string","description":"The user-specified industry associated with the account."},"account_name":{"type":"string","description":"The name of the account."},"account_timezone":{"type":"string","description":"The timezone currently set for the account."},"avatar_url":{"type":"string","description":"URL of the avatar for the user."},"contact":{"$ref":"#/components/schemas/30GetResponsesContentApplicationJsonSchemaContact","description":"Information about the account contact."},"email":{"type":"string","description":"The account email address."},"first_name":{"type":"string","description":"The first name tied to the account."},"first_payment":{"$ref":"#/components/schemas/30GetResponsesContentApplicationJsonSchemaFirstPayment","description":"Date of first payment for monthly plans."},"industry_stats":{"$ref":"#/components/schemas/30GetResponsesContentApplicationJsonSchemaIndustryStats","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."},"last_login":{"type":"string","format":"date-time","description":"The date and time of the last login for this account in ISO 8601 format."},"last_name":{"type":"string","description":"The last name tied to the account."},"login_id":{"type":"string","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."},"member_since":{"type":"string","format":"date-time","description":"The date and time that the account was created in ISO 8601 format."},"pricing_plan_type":{"$ref":"#/components/schemas/30GetResponsesContentApplicationJsonSchemaPricingPlanType","description":"The type of pricing plan the account is on."},"pro_enabled":{"type":"boolean","description":"Legacy - whether the account includes [Mailchimp Pro](https://mailchimp.com/help/about-legacy-pricing-plan/)."},"role":{"type":"string","description":"The [user role](https://mailchimp.com/help/manage-user-levels-in-your-account/) for the account."},"total_subscribers":{"type":"integer","description":"The total number of subscribers across all lists in the account."},"username":{"type":"string","description":"The username tied to the account."}},"description":"The API root resource links to all other resources available in the API.","title":"root_list_Response_200"},"30AccountExportsGetResponsesContentApplicationJsonSchemaLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"30AccountExportsGetResponsesContentApplicationJsonSchemaLinksItemsMethod"},"30AccountExportsGetResponsesContentApplicationJsonSchemaLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/30AccountExportsGetResponsesContentApplicationJsonSchemaLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"30AccountExportsGetResponsesContentApplicationJsonSchemaLinksItems"},"30AccountExportsGetResponsesContentApplicationJsonSchemaExportsItemsLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"30AccountExportsGetResponsesContentApplicationJsonSchemaExportsItemsLinksItemsMethod"},"30AccountExportsGetResponsesContentApplicationJsonSchemaExportsItemsLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/30AccountExportsGetResponsesContentApplicationJsonSchemaExportsItemsLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"30AccountExportsGetResponsesContentApplicationJsonSchemaExportsItemsLinksItems"},"30AccountExportsGetResponsesContentApplicationJsonSchemaExportsItems":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/30AccountExportsGetResponsesContentApplicationJsonSchemaExportsItemsLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"download_url":{"type":"string","description":"If the export is finished, the download URL for an export. URLs are only valid for 90 days after the export completes."},"export_id":{"type":"integer","description":"The ID for the export."},"finished":{"type":"string","format":"date-time","description":"If finished, the finish time for the export."},"size_in_bytes":{"type":"integer","description":"The size of the uncompressed export in bytes."},"started":{"type":"string","format":"date-time","description":"Start time for the export."}},"description":"An account export.","title":"30AccountExportsGetResponsesContentApplicationJsonSchemaExportsItems"},"account-exports_list_Response_200":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/30AccountExportsGetResponsesContentApplicationJsonSchemaLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"exports":{"type":"array","items":{"$ref":"#/components/schemas/30AccountExportsGetResponsesContentApplicationJsonSchemaExportsItems"},"description":"An array of objects, each representing an account export."},"total_items":{"type":"integer","description":"The total number of items matching the query regardless of pagination."}},"description":"An array of objects, each representing an account export.","title":"account-exports_list_Response_200"},"30AccountExportsPostRequestBodyContentApplicationJsonSchemaIncludeStagesItems":{"type":"string","enum":["audiences","campaigns","events","gallery_files","reports","templates"],"title":"30AccountExportsPostRequestBodyContentApplicationJsonSchemaIncludeStagesItems"},"30AccountExportsPostResponsesContentApplicationJsonSchemaLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"30AccountExportsPostResponsesContentApplicationJsonSchemaLinksItemsMethod"},"30AccountExportsPostResponsesContentApplicationJsonSchemaLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/30AccountExportsPostResponsesContentApplicationJsonSchemaLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"30AccountExportsPostResponsesContentApplicationJsonSchemaLinksItems"},"account-exports_create_Response_200":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/30AccountExportsPostResponsesContentApplicationJsonSchemaLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"download_url":{"type":"string","description":"If the export is finished, the download URL for an export. URLs are only valid for 90 days after the export completes."},"export_id":{"type":"integer","description":"The ID for the export."},"finished":{"type":"string","format":"date-time","description":"If finished, the finish time for the export."},"size_in_bytes":{"type":"integer","description":"The size of the uncompressed export in bytes."},"started":{"type":"string","format":"date-time","description":"Start time for the export."}},"description":"An account export.","title":"account-exports_create_Response_200"},"30AccountExportsExportIdGetResponsesContentApplicationJsonSchemaLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"30AccountExportsExportIdGetResponsesContentApplicationJsonSchemaLinksItemsMethod"},"30AccountExportsExportIdGetResponsesContentApplicationJsonSchemaLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/30AccountExportsExportIdGetResponsesContentApplicationJsonSchemaLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"30AccountExportsExportIdGetResponsesContentApplicationJsonSchemaLinksItems"},"account-exports_get_Response_200":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/30AccountExportsExportIdGetResponsesContentApplicationJsonSchemaLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"download_url":{"type":"string","description":"If the export is finished, the download URL for an export. URLs are only valid for 90 days after the export completes."},"export_id":{"type":"integer","description":"The ID for the export."},"finished":{"type":"string","format":"date-time","description":"If finished, the finish time for the export."},"size_in_bytes":{"type":"integer","description":"The size of the uncompressed export in bytes."},"started":{"type":"string","format":"date-time","description":"Start time for the export."}},"description":"An account export.","title":"account-exports_get_Response_200"},"30ActivityFeedGetResponsesContentApplicationJsonSchemaItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"30ActivityFeedGetResponsesContentApplicationJsonSchemaItemsMethod"},"30ActivityFeedGetResponsesContentApplicationJsonSchemaItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/30ActivityFeedGetResponsesContentApplicationJsonSchemaItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"30ActivityFeedGetResponsesContentApplicationJsonSchemaItems"},"30ActivityFeedChimpChatterGetResponsesContentApplicationJsonSchemaLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"30ActivityFeedChimpChatterGetResponsesContentApplicationJsonSchemaLinksItemsMethod"},"30ActivityFeedChimpChatterGetResponsesContentApplicationJsonSchemaLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/30ActivityFeedChimpChatterGetResponsesContentApplicationJsonSchemaLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"30ActivityFeedChimpChatterGetResponsesContentApplicationJsonSchemaLinksItems"},"30ActivityFeedChimpChatterGetResponsesContentApplicationJsonSchemaChimpChatterItemsType":{"type":"string","enum":["lists:new-subscriber","lists:unsubscribes","lists:profile-updates","campaigns:facebook-likes","campaigns:forward-to-friend","lists:imports"],"description":"The type of activity","title":"30ActivityFeedChimpChatterGetResponsesContentApplicationJsonSchemaChimpChatterItemsType"},"30ActivityFeedChimpChatterGetResponsesContentApplicationJsonSchemaChimpChatterItems":{"type":"object","properties":{"campaign_id":{"type":"string","description":"If it exists, campaign ID for the associated campaign"},"list_id":{"type":"string","description":"If it exists, list ID for the associated list"},"message":{"type":"string"},"title":{"type":"string"},"type":{"$ref":"#/components/schemas/30ActivityFeedChimpChatterGetResponsesContentApplicationJsonSchemaChimpChatterItemsType","description":"The type of activity"},"update_time":{"type":"string","format":"date-time","description":"The date and time this activity was updated."},"url":{"type":"string","description":"URL to a report that includes this activity"}},"description":"A Chimp Chatter message","title":"30ActivityFeedChimpChatterGetResponsesContentApplicationJsonSchemaChimpChatterItems"},"activity-feed_list-chimp-chatter_Response_200":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/30ActivityFeedChimpChatterGetResponsesContentApplicationJsonSchemaLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"chimp_chatter":{"type":"array","items":{"$ref":"#/components/schemas/30ActivityFeedChimpChatterGetResponsesContentApplicationJsonSchemaChimpChatterItems"},"description":"An array of Chimp Chatter messages. There's a maximum of 200 messages present for an account."},"total_items":{"type":"integer","description":"The total number of items matching the query regardless of pagination."}},"description":"An array of Chimp Chatter messages. There's a maximum of 200 messages present for an account.","title":"activity-feed_list-chimp-chatter_Response_200"},"30AudiencesAudienceIdContactsGetParametersSortField":{"type":"string","enum":["created_at","updated_at"],"title":"30AudiencesAudienceIdContactsGetParametersSortField"},"30AudiencesAudienceIdContactsGetParametersSortDir":{"type":"string","enum":["ASC","DESC"],"title":"30AudiencesAudienceIdContactsGetParametersSortDir"},"AudiencesContactEmailChannelEffectiveSubscriptionStatusValue":{"type":"string","enum":["subscribed","unsubscribed","nonsubscribed","pending"],"title":"AudiencesContactEmailChannelEffectiveSubscriptionStatusValue"},"AudiencesContactEmailChannelEffectiveSubscriptionStatus":{"type":"object","properties":{"value":{"$ref":"#/components/schemas/AudiencesContactEmailChannelEffectiveSubscriptionStatusValue"}},"description":"A computation performed by the Mailchimp platform, triggered whenever any of its inputs change. Some inputs are controlled by API users, while others are tracked internally by the platform. Computation is based on: audience opt-in configuration (single vs. double opt-in), marketing consent status, and deliverability status (an internal state for a contact, maintained by Mailchimp for a specific marketing channel instance). This new API field is distinct from how contacts are displayed in the UI. See the [Audiences (BETA) documentation](https://mailchimp.com/developer/marketing/docs/audiences-introduction) to learn about supported values.","title":"AudiencesContactEmailChannelEffectiveSubscriptionStatus"},"AudiencesContactEmailChannelMarketingConsentSource":{"type":"object","properties":{"name":{"type":"string","description":"The name of the entity's source"}},"description":"The source from which the parent's entity was created.","title":"AudiencesContactEmailChannelMarketingConsentSource"},"AudiencesContactEmailChannelMarketingConsentStatus":{"type":"string","enum":["consented","denied","confirmed","unknown"],"title":"AudiencesContactEmailChannelMarketingConsentStatus"},"AudiencesContactEmailChannelMarketingConsent":{"type":"object","properties":{"source":{"$ref":"#/components/schemas/AudiencesContactEmailChannelMarketingConsentSource","description":"The source from which the parent's entity was created."},"status":{"$ref":"#/components/schemas/AudiencesContactEmailChannelMarketingConsentStatus"},"captured_at":{"type":"string","format":"date-time","description":"The ISO 8601 timestamp when the email marketing consent state was recorded; accepted and returned only when status is `confirmed` or `consented`; defaults to the current time if omitted; ignored if older than an existing stored timestamp (staleness guard)."}},"description":"A contact's current consent status for email marketing communications. See the [Audiences (BETA) documentation](https://mailchimp.com/developer/marketing/docs/audiences-introduction) to learn about supported values.","title":"AudiencesContactEmailChannelMarketingConsent"},"AudiencesContactEmailChannelSource":{"type":"object","properties":{"name":{"type":"string","description":"The name of the entity's source"}},"description":"The source from which the parent's entity was created.","title":"AudiencesContactEmailChannelSource"},"AudiencesContactEmailChannel":{"type":"object","properties":{"effective_subscription_status":{"$ref":"#/components/schemas/AudiencesContactEmailChannelEffectiveSubscriptionStatus","description":"A computation performed by the Mailchimp platform, triggered whenever any of its inputs change. Some inputs are controlled by API users, while others are tracked internally by the platform. Computation is based on: audience opt-in configuration (single vs. double opt-in), marketing consent status, and deliverability status (an internal state for a contact, maintained by Mailchimp for a specific marketing channel instance). This new API field is distinct from how contacts are displayed in the UI. See the [Audiences (BETA) documentation](https://mailchimp.com/developer/marketing/docs/audiences-introduction) to learn about supported values."},"email":{"type":"string","description":"Email address"},"hashed_email":{"type":"string","description":"MD5 hash of the email address"},"marketing_consent":{"$ref":"#/components/schemas/AudiencesContactEmailChannelMarketingConsent","description":"A contact's current consent status for email marketing communications. See the [Audiences (BETA) documentation](https://mailchimp.com/developer/marketing/docs/audiences-introduction) to learn about supported values."},"source":{"$ref":"#/components/schemas/AudiencesContactEmailChannelSource","description":"The source from which the parent's entity was created."}},"title":"AudiencesContactEmailChannel"},"AudiencesContactLanguage":{"type":"string","enum":["","en","ar","af","be","bg","ca","zh","zh_CN","hr","cs","da","nl","et","fa","fi","fr","fr_CA","de","el","he","hi","hu","is","id","ga","it","ja","km","ko","lv","lt","mt","ms","mk","no","pl","pt","pt_PT","ro","ru","sr","sk","sl","es","es_ES","sw","sv","ta","th","tr","uk","vi"],"description":"The contact's detected language. Empty string when no language has been detected or set.","title":"AudiencesContactLanguage"},"AudiencesContactMergeFields0":{"type":"object","properties":{"addr1":{"type":"string"},"addr2":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"zip":{"type":"string"},"country":{"type":"string"}},"required":["addr1","city","state","zip"],"title":"AudiencesContactMergeFields0"},"AudiencesContactMergeFields":{"oneOf":[{"$ref":"#/components/schemas/AudiencesContactMergeFields0"},{"type":"string"},{"type":"number","format":"double"}],"description":"This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field.","title":"AudiencesContactMergeFields"},"AudiencesContactSmsChannelEffectiveSubscriptionStatusValue":{"type":"string","enum":["subscribed","unsubscribed","nonsubscribed","pending"],"title":"AudiencesContactSmsChannelEffectiveSubscriptionStatusValue"},"AudiencesContactSmsChannelEffectiveSubscriptionStatus":{"type":"object","properties":{"value":{"$ref":"#/components/schemas/AudiencesContactSmsChannelEffectiveSubscriptionStatusValue"}},"description":"A computation performed by the Mailchimp platform, triggered whenever any of its inputs change. Some inputs are controlled by API users, while others are tracked internally by the platform. Computation is based on: audience opt-in configuration (single vs. double opt-in), marketing consent status, and deliverability status (an internal state for a contact, maintained by Mailchimp for a specific marketing channel instance). This new API field is distinct from how contacts are displayed in the UI. See the [Audiences (BETA) documentation](https://mailchimp.com/developer/marketing/docs/audiences-introduction) to learn about supported values.","title":"AudiencesContactSmsChannelEffectiveSubscriptionStatus"},"AudiencesContactSmsChannelMarketingConsentSource":{"type":"object","properties":{"name":{"type":"string","description":"The name of the entity's source"}},"description":"The source from which the parent's entity was created.","title":"AudiencesContactSmsChannelMarketingConsentSource"},"AudiencesContactSmsChannelMarketingConsentStatus":{"type":"string","enum":["consented","confirmed","denied","unknown"],"description":"The contact's SMS marketing consent status. Use `confirmed` for double opt-in audiences, `consented` for single opt-in audiences. `denied` is accepted on PATCH/PUT only (not POST) and drives an API-initiated unsubscribe; it cannot be used when creating a new contact.","title":"AudiencesContactSmsChannelMarketingConsentStatus"},"AudiencesContactSmsChannelMarketingConsent":{"type":"object","properties":{"source":{"$ref":"#/components/schemas/AudiencesContactSmsChannelMarketingConsentSource","description":"The source from which the parent's entity was created."},"status":{"$ref":"#/components/schemas/AudiencesContactSmsChannelMarketingConsentStatus","description":"The contact's SMS marketing consent status. Use `confirmed` for double opt-in audiences, `consented` for single opt-in audiences. `denied` is accepted on PATCH/PUT only (not POST) and drives an API-initiated unsubscribe; it cannot be used when creating a new contact."},"captured_at":{"type":"string","format":"date-time","description":"The timestamp when SMS marketing consent was captured (ISO 8601). Only accepted and returned when status is `confirmed`. The timestamp of the consent state change being recorded. Defaults to the current time if not provided. If the contact already has a consent timestamp on record that is equal to or newer than the supplied value, the supplied value is ignored (staleness guard); to update the consent timestamp supply a value strictly newer than the stored one."}},"description":"A contact's current consent status for SMS marketing communications. See the [Audiences (BETA) documentation](https://mailchimp.com/developer/marketing/docs/audiences-introduction) to learn about supported values.","title":"AudiencesContactSmsChannelMarketingConsent"},"AudiencesContactSmsChannelSource":{"type":"object","properties":{"name":{"type":"string","description":"The name of the entity's source"}},"description":"The source from which the parent's entity was created.","title":"AudiencesContactSmsChannelSource"},"AudiencesContactSmsChannel":{"type":"object","properties":{"effective_subscription_status":{"$ref":"#/components/schemas/AudiencesContactSmsChannelEffectiveSubscriptionStatus","description":"A computation performed by the Mailchimp platform, triggered whenever any of its inputs change. Some inputs are controlled by API users, while others are tracked internally by the platform. Computation is based on: audience opt-in configuration (single vs. double opt-in), marketing consent status, and deliverability status (an internal state for a contact, maintained by Mailchimp for a specific marketing channel instance). This new API field is distinct from how contacts are displayed in the UI. See the [Audiences (BETA) documentation](https://mailchimp.com/developer/marketing/docs/audiences-introduction) to learn about supported values."},"marketing_consent":{"$ref":"#/components/schemas/AudiencesContactSmsChannelMarketingConsent","description":"A contact's current consent status for SMS marketing communications. See the [Audiences (BETA) documentation](https://mailchimp.com/developer/marketing/docs/audiences-introduction) to learn about supported values."},"sms_phone":{"type":"string","description":"SMS Phone Number"},"source":{"$ref":"#/components/schemas/AudiencesContactSmsChannelSource","description":"The source from which the parent's entity was created."},"hashed_sms_phone":{"type":"string","description":"SHA256 hash of the SMS phone number"}},"title":"AudiencesContactSmsChannel"},"AudiencesContactSource":{"type":"object","properties":{"name":{"type":"string","description":"The name of the entity's source"}},"description":"The source from which the parent's entity was created.","title":"AudiencesContactSource"},"AudiencesContactStatus":{"type":"string","enum":["active","archived"],"description":"The status of a contact.","title":"AudiencesContactStatus"},"AudiencesContact":{"type":"object","properties":{"audience_id":{"type":"string","description":"The unique ID for the audience."},"created_at":{"type":"string","format":"date-time","description":"The date that the contact was created."},"email_channel":{"$ref":"#/components/schemas/AudiencesContactEmailChannel"},"id":{"type":"string","description":"The unique ID for the contact."},"language":{"$ref":"#/components/schemas/AudiencesContactLanguage","description":"The contact's detected language. Empty string when no language has been detected or set."},"last_updated_at":{"type":"string","format":"date-time","description":"The date that the contact was last updated."},"merge_fields":{"type":["object","null"],"additionalProperties":{"$ref":"#/components/schemas/AudiencesContactMergeFields"},"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."},"sms_channel":{"$ref":"#/components/schemas/AudiencesContactSmsChannel"},"source":{"$ref":"#/components/schemas/AudiencesContactSource","description":"The source from which the parent's entity was created."},"status":{"$ref":"#/components/schemas/AudiencesContactStatus","description":"The status of a contact."},"tags":{"type":"array","items":{"type":"string"},"description":"The tags assigned to this contact."}},"description":"An instance of a contact.","title":"AudiencesContact"},"30AudiencesAudienceIdContactsGetResponsesContentApplicationJsonSchemaLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"30AudiencesAudienceIdContactsGetResponsesContentApplicationJsonSchemaLinksItemsMethod"},"30AudiencesAudienceIdContactsGetResponsesContentApplicationJsonSchemaLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/30AudiencesAudienceIdContactsGetResponsesContentApplicationJsonSchemaLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"30AudiencesAudienceIdContactsGetResponsesContentApplicationJsonSchemaLinksItems"},"audiences_getAudienceContactList_Response_200":{"type":"object","properties":{"contacts":{"type":"array","items":{"$ref":"#/components/schemas/AudiencesContact"},"description":"An array of objects, each representing a contact record."},"next_cursor":{"type":"string","description":"A cursor pointing to the last item on this page of the collection. Paginate through a collection of records by setting the `cursor` parameter on a subsequent request to this value."},"_links":{"type":"array","items":{"$ref":"#/components/schemas/30AudiencesAudienceIdContactsGetResponsesContentApplicationJsonSchemaLinksItems"},"description":"A list of link types and descriptions for the API schema documents."}},"description":"An array of objects, each representing a contact record.","title":"audiences_getAudienceContactList_Response_200"},"30AudiencesAudienceIdContactsPostParametersMergeFieldValidationMode":{"type":"string","enum":["ignore_required_checks","strict"],"title":"30AudiencesAudienceIdContactsPostParametersMergeFieldValidationMode"},"30AudiencesAudienceIdContactsPostParametersDataMode":{"type":"string","enum":["historical","live"],"title":"30AudiencesAudienceIdContactsPostParametersDataMode"},"30AudiencesAudienceIdContactsPostRequestBodyContentApplicationJsonSchemaEmailChannelMarketingConsentStatus":{"type":"string","enum":["confirmed","consented","denied","unknown"],"description":"Status of a contacts Marketing Consent","title":"30AudiencesAudienceIdContactsPostRequestBodyContentApplicationJsonSchemaEmailChannelMarketingConsentStatus"},"30AudiencesAudienceIdContactsPostRequestBodyContentApplicationJsonSchemaEmailChannelMarketingConsent":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/30AudiencesAudienceIdContactsPostRequestBodyContentApplicationJsonSchemaEmailChannelMarketingConsentStatus","description":"Status of a contacts Marketing Consent"}},"description":"A contact's current consent status for email marketing communications. See the [Audiences (BETA) documentation](https://mailchimp.com/developer/marketing/docs/audiences-introduction) to learn about supported values.","title":"30AudiencesAudienceIdContactsPostRequestBodyContentApplicationJsonSchemaEmailChannelMarketingConsent"},"30AudiencesAudienceIdContactsPostRequestBodyContentApplicationJsonSchemaEmailChannel":{"type":"object","properties":{"email":{"type":"string","description":"Email address"},"marketing_consent":{"$ref":"#/components/schemas/30AudiencesAudienceIdContactsPostRequestBodyContentApplicationJsonSchemaEmailChannelMarketingConsent","description":"A contact's current consent status for email marketing communications. See the [Audiences (BETA) documentation](https://mailchimp.com/developer/marketing/docs/audiences-introduction) to learn about supported values."}},"title":"30AudiencesAudienceIdContactsPostRequestBodyContentApplicationJsonSchemaEmailChannel"},"30AudiencesAudienceIdContactsPostRequestBodyContentApplicationJsonSchemaMergeFields0":{"type":"object","properties":{"addr1":{"type":"string"},"addr2":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"zip":{"type":"string"},"country":{"type":"string"}},"required":["addr1","city","state","zip"],"title":"30AudiencesAudienceIdContactsPostRequestBodyContentApplicationJsonSchemaMergeFields0"},"30AudiencesAudienceIdContactsPostRequestBodyContentApplicationJsonSchemaMergeFields":{"oneOf":[{"$ref":"#/components/schemas/30AudiencesAudienceIdContactsPostRequestBodyContentApplicationJsonSchemaMergeFields0"},{"type":"string"},{"type":"number","format":"double"}],"description":"This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field.","title":"30AudiencesAudienceIdContactsPostRequestBodyContentApplicationJsonSchemaMergeFields"},"30AudiencesAudienceIdContactsPostRequestBodyContentApplicationJsonSchemaSmsChannelMarketingConsentSource":{"type":"object","properties":{"name":{"type":"string","description":"The name of the entity's source"}},"description":"The source from which the parent's entity was created.","title":"30AudiencesAudienceIdContactsPostRequestBodyContentApplicationJsonSchemaSmsChannelMarketingConsentSource"},"30AudiencesAudienceIdContactsPostRequestBodyContentApplicationJsonSchemaSmsChannelMarketingConsentStatus":{"type":"string","enum":["consented","confirmed","unknown"],"description":"The contact's SMS marketing consent status. Use `confirmed` for double opt-in audiences, `consented` for single opt-in audiences.","title":"30AudiencesAudienceIdContactsPostRequestBodyContentApplicationJsonSchemaSmsChannelMarketingConsentStatus"},"30AudiencesAudienceIdContactsPostRequestBodyContentApplicationJsonSchemaSmsChannelMarketingConsent":{"type":"object","properties":{"source":{"$ref":"#/components/schemas/30AudiencesAudienceIdContactsPostRequestBodyContentApplicationJsonSchemaSmsChannelMarketingConsentSource","description":"The source from which the parent's entity was created."},"status":{"$ref":"#/components/schemas/30AudiencesAudienceIdContactsPostRequestBodyContentApplicationJsonSchemaSmsChannelMarketingConsentStatus","description":"The contact's SMS marketing consent status. Use `confirmed` for double opt-in audiences, `consented` for single opt-in audiences."},"captured_at":{"type":"string","format":"date-time","description":"The timestamp when SMS marketing consent was captured (ISO 8601). Only accepted and returned when status is `confirmed`. The timestamp of the consent state change being recorded. Defaults to the current time if not provided. If the contact already has a consent timestamp on record that is equal to or newer than the supplied value, the supplied value is ignored (staleness guard); to update the consent timestamp supply a value strictly newer than the stored one."}},"description":"A contact's current consent status for SMS marketing communications. See the [Audiences (BETA) documentation](https://mailchimp.com/developer/marketing/docs/audiences-introduction) to learn about supported values.","title":"30AudiencesAudienceIdContactsPostRequestBodyContentApplicationJsonSchemaSmsChannelMarketingConsent"},"30AudiencesAudienceIdContactsPostRequestBodyContentApplicationJsonSchemaSmsChannel":{"type":"object","properties":{"marketing_consent":{"$ref":"#/components/schemas/30AudiencesAudienceIdContactsPostRequestBodyContentApplicationJsonSchemaSmsChannelMarketingConsent","description":"A contact's current consent status for SMS marketing communications. See the [Audiences (BETA) documentation](https://mailchimp.com/developer/marketing/docs/audiences-introduction) to learn about supported values."},"sms_phone":{"type":"string","description":"SMS Phone Number"}},"title":"30AudiencesAudienceIdContactsPostRequestBodyContentApplicationJsonSchemaSmsChannel"},"30AudiencesAudienceIdContactsPostRequestBodyContentApplicationJsonSchemaTagsItemsOneOf1Status":{"type":"string","enum":["active","inactive"],"title":"30AudiencesAudienceIdContactsPostRequestBodyContentApplicationJsonSchemaTagsItemsOneOf1Status"},"30AudiencesAudienceIdContactsPostRequestBodyContentApplicationJsonSchemaTagsItems1":{"type":"object","properties":{"name":{"type":"string"},"status":{"$ref":"#/components/schemas/30AudiencesAudienceIdContactsPostRequestBodyContentApplicationJsonSchemaTagsItemsOneOf1Status"}},"required":["name","status"],"title":"30AudiencesAudienceIdContactsPostRequestBodyContentApplicationJsonSchemaTagsItems1"},"30AudiencesAudienceIdContactsPostRequestBodyContentApplicationJsonSchemaTagsItems":{"oneOf":[{"type":"string"},{"$ref":"#/components/schemas/30AudiencesAudienceIdContactsPostRequestBodyContentApplicationJsonSchemaTagsItems1"}],"title":"30AudiencesAudienceIdContactsPostRequestBodyContentApplicationJsonSchemaTagsItems"},"30AudiencesAudienceIdContactsContactIdPatchParametersMergeFieldValidationMode":{"type":"string","enum":["ignore_required_checks","strict"],"title":"30AudiencesAudienceIdContactsContactIdPatchParametersMergeFieldValidationMode"},"30AudiencesAudienceIdContactsContactIdPatchParametersDataMode":{"type":"string","enum":["historical","live"],"title":"30AudiencesAudienceIdContactsContactIdPatchParametersDataMode"},"30AudiencesAudienceIdContactsContactIdPatchRequestBodyContentApplicationJsonSchemaEmailChannelMarketingConsentSource":{"type":"object","properties":{"name":{"type":"string","description":"The name of the entity's source"}},"description":"The source from which the parent's entity was created.","title":"30AudiencesAudienceIdContactsContactIdPatchRequestBodyContentApplicationJsonSchemaEmailChannelMarketingConsentSource"},"30AudiencesAudienceIdContactsContactIdPatchRequestBodyContentApplicationJsonSchemaEmailChannelMarketingConsentStatus":{"type":"string","enum":["consented","denied","confirmed","unknown"],"title":"30AudiencesAudienceIdContactsContactIdPatchRequestBodyContentApplicationJsonSchemaEmailChannelMarketingConsentStatus"},"30AudiencesAudienceIdContactsContactIdPatchRequestBodyContentApplicationJsonSchemaEmailChannelMarketingConsent":{"type":"object","properties":{"source":{"$ref":"#/components/schemas/30AudiencesAudienceIdContactsContactIdPatchRequestBodyContentApplicationJsonSchemaEmailChannelMarketingConsentSource","description":"The source from which the parent's entity was created."},"status":{"$ref":"#/components/schemas/30AudiencesAudienceIdContactsContactIdPatchRequestBodyContentApplicationJsonSchemaEmailChannelMarketingConsentStatus"},"captured_at":{"type":"string","format":"date-time","description":"The ISO 8601 timestamp when the email marketing consent state was recorded; accepted and returned only when status is `confirmed` or `consented`; defaults to the current time if omitted; ignored if older than an existing stored timestamp (staleness guard)."}},"description":"A contact's current consent status for email marketing communications. See the [Audiences (BETA) documentation](https://mailchimp.com/developer/marketing/docs/audiences-introduction) to learn about supported values.","title":"30AudiencesAudienceIdContactsContactIdPatchRequestBodyContentApplicationJsonSchemaEmailChannelMarketingConsent"},"30AudiencesAudienceIdContactsContactIdPatchRequestBodyContentApplicationJsonSchemaEmailChannel":{"type":"object","properties":{"email":{"type":"string","description":"Email address"},"marketing_consent":{"$ref":"#/components/schemas/30AudiencesAudienceIdContactsContactIdPatchRequestBodyContentApplicationJsonSchemaEmailChannelMarketingConsent","description":"A contact's current consent status for email marketing communications. See the [Audiences (BETA) documentation](https://mailchimp.com/developer/marketing/docs/audiences-introduction) to learn about supported values."}},"title":"30AudiencesAudienceIdContactsContactIdPatchRequestBodyContentApplicationJsonSchemaEmailChannel"},"30AudiencesAudienceIdContactsContactIdPatchRequestBodyContentApplicationJsonSchemaMergeFields0":{"type":"object","properties":{"addr1":{"type":"string"},"addr2":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"zip":{"type":"string"},"country":{"type":"string"}},"required":["addr1","city","state","zip"],"title":"30AudiencesAudienceIdContactsContactIdPatchRequestBodyContentApplicationJsonSchemaMergeFields0"},"30AudiencesAudienceIdContactsContactIdPatchRequestBodyContentApplicationJsonSchemaMergeFields":{"oneOf":[{"$ref":"#/components/schemas/30AudiencesAudienceIdContactsContactIdPatchRequestBodyContentApplicationJsonSchemaMergeFields0"},{"type":"string"},{"type":"number","format":"double"}],"description":"This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field.","title":"30AudiencesAudienceIdContactsContactIdPatchRequestBodyContentApplicationJsonSchemaMergeFields"},"30AudiencesAudienceIdContactsContactIdPatchRequestBodyContentApplicationJsonSchemaSmsChannelMarketingConsentSource":{"type":"object","properties":{"name":{"type":"string","description":"The name of the entity's source"}},"description":"The source from which the parent's entity was created.","title":"30AudiencesAudienceIdContactsContactIdPatchRequestBodyContentApplicationJsonSchemaSmsChannelMarketingConsentSource"},"30AudiencesAudienceIdContactsContactIdPatchRequestBodyContentApplicationJsonSchemaSmsChannelMarketingConsentStatus":{"type":"string","enum":["consented","confirmed","denied","unknown"],"description":"The contact's SMS marketing consent status. Use `confirmed` for double opt-in audiences, `consented` for single opt-in audiences. `denied` is accepted on PATCH/PUT only (not POST) and drives an API-initiated unsubscribe; it cannot be used when creating a new contact.","title":"30AudiencesAudienceIdContactsContactIdPatchRequestBodyContentApplicationJsonSchemaSmsChannelMarketingConsentStatus"},"30AudiencesAudienceIdContactsContactIdPatchRequestBodyContentApplicationJsonSchemaSmsChannelMarketingConsent":{"type":"object","properties":{"source":{"$ref":"#/components/schemas/30AudiencesAudienceIdContactsContactIdPatchRequestBodyContentApplicationJsonSchemaSmsChannelMarketingConsentSource","description":"The source from which the parent's entity was created."},"status":{"$ref":"#/components/schemas/30AudiencesAudienceIdContactsContactIdPatchRequestBodyContentApplicationJsonSchemaSmsChannelMarketingConsentStatus","description":"The contact's SMS marketing consent status. Use `confirmed` for double opt-in audiences, `consented` for single opt-in audiences. `denied` is accepted on PATCH/PUT only (not POST) and drives an API-initiated unsubscribe; it cannot be used when creating a new contact."},"captured_at":{"type":"string","format":"date-time","description":"The timestamp when SMS marketing consent was captured (ISO 8601). Only accepted and returned when status is `confirmed`. The timestamp of the consent state change being recorded. Defaults to the current time if not provided. If the contact already has a consent timestamp on record that is equal to or newer than the supplied value, the supplied value is ignored (staleness guard); to update the consent timestamp supply a value strictly newer than the stored one."}},"description":"A contact's current consent status for SMS marketing communications. See the [Audiences (BETA) documentation](https://mailchimp.com/developer/marketing/docs/audiences-introduction) to learn about supported values.","title":"30AudiencesAudienceIdContactsContactIdPatchRequestBodyContentApplicationJsonSchemaSmsChannelMarketingConsent"},"30AudiencesAudienceIdContactsContactIdPatchRequestBodyContentApplicationJsonSchemaSmsChannel":{"type":"object","properties":{"marketing_consent":{"$ref":"#/components/schemas/30AudiencesAudienceIdContactsContactIdPatchRequestBodyContentApplicationJsonSchemaSmsChannelMarketingConsent","description":"A contact's current consent status for SMS marketing communications. See the [Audiences (BETA) documentation](https://mailchimp.com/developer/marketing/docs/audiences-introduction) to learn about supported values."},"sms_phone":{"type":"string","description":"SMS Phone Number"}},"title":"30AudiencesAudienceIdContactsContactIdPatchRequestBodyContentApplicationJsonSchemaSmsChannel"},"30AudiencesAudienceIdContactsContactIdPatchRequestBodyContentApplicationJsonSchemaTagsItemsOneOf1Status":{"type":"string","enum":["active","inactive"],"title":"30AudiencesAudienceIdContactsContactIdPatchRequestBodyContentApplicationJsonSchemaTagsItemsOneOf1Status"},"30AudiencesAudienceIdContactsContactIdPatchRequestBodyContentApplicationJsonSchemaTagsItems1":{"type":"object","properties":{"name":{"type":"string"},"status":{"$ref":"#/components/schemas/30AudiencesAudienceIdContactsContactIdPatchRequestBodyContentApplicationJsonSchemaTagsItemsOneOf1Status"}},"required":["name","status"],"title":"30AudiencesAudienceIdContactsContactIdPatchRequestBodyContentApplicationJsonSchemaTagsItems1"},"30AudiencesAudienceIdContactsContactIdPatchRequestBodyContentApplicationJsonSchemaTagsItems":{"oneOf":[{"type":"string"},{"$ref":"#/components/schemas/30AudiencesAudienceIdContactsContactIdPatchRequestBodyContentApplicationJsonSchemaTagsItems1"}],"title":"30AudiencesAudienceIdContactsContactIdPatchRequestBodyContentApplicationJsonSchemaTagsItems"},"30AuthorizedAppsGetResponsesContentApplicationJsonSchemaLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"30AuthorizedAppsGetResponsesContentApplicationJsonSchemaLinksItemsMethod"},"30AuthorizedAppsGetResponsesContentApplicationJsonSchemaLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/30AuthorizedAppsGetResponsesContentApplicationJsonSchemaLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"30AuthorizedAppsGetResponsesContentApplicationJsonSchemaLinksItems"},"30AuthorizedAppsGetResponsesContentApplicationJsonSchemaAppsItemsLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"30AuthorizedAppsGetResponsesContentApplicationJsonSchemaAppsItemsLinksItemsMethod"},"30AuthorizedAppsGetResponsesContentApplicationJsonSchemaAppsItemsLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/30AuthorizedAppsGetResponsesContentApplicationJsonSchemaAppsItemsLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"30AuthorizedAppsGetResponsesContentApplicationJsonSchemaAppsItemsLinksItems"},"30AuthorizedAppsGetResponsesContentApplicationJsonSchemaAppsItems":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/30AuthorizedAppsGetResponsesContentApplicationJsonSchemaAppsItemsLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"description":{"type":"string","description":"A short description of the application."},"id":{"type":"integer","description":"The ID for the application."},"name":{"type":"string","description":"The name of the application."},"users":{"type":"array","items":{"type":"string"},"description":"An array of usernames for users who have linked the app."}},"description":"An authorized app.","title":"30AuthorizedAppsGetResponsesContentApplicationJsonSchemaAppsItems"},"authorized-apps_list_Response_200":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/30AuthorizedAppsGetResponsesContentApplicationJsonSchemaLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"apps":{"type":"array","items":{"$ref":"#/components/schemas/30AuthorizedAppsGetResponsesContentApplicationJsonSchemaAppsItems"},"description":"An array of objects, each representing an authorized application."},"total_items":{"type":"integer","description":"The total number of items matching the query regardless of pagination."}},"description":"An array of objects, each representing an authorized application.","title":"authorized-apps_list_Response_200"},"30AuthorizedAppsAppIdGetResponsesContentApplicationJsonSchemaLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"30AuthorizedAppsAppIdGetResponsesContentApplicationJsonSchemaLinksItemsMethod"},"30AuthorizedAppsAppIdGetResponsesContentApplicationJsonSchemaLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/30AuthorizedAppsAppIdGetResponsesContentApplicationJsonSchemaLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"30AuthorizedAppsAppIdGetResponsesContentApplicationJsonSchemaLinksItems"},"authorized-apps_get_Response_200":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/30AuthorizedAppsAppIdGetResponsesContentApplicationJsonSchemaLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"description":{"type":"string","description":"A short description of the application."},"id":{"type":"integer","description":"The ID for the application."},"name":{"type":"string","description":"The name of the application."},"users":{"type":"array","items":{"type":"string"},"description":"An array of usernames for users who have linked the app."}},"description":"An authorized app.","title":"authorized-apps_get_Response_200"},"30AutomationsGetParametersStatus":{"type":"string","enum":["save","paused","sending"],"title":"30AutomationsGetParametersStatus"},"30AutomationsGetResponsesContentApplicationJsonSchemaLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"30AutomationsGetResponsesContentApplicationJsonSchemaLinksItemsMethod"},"30AutomationsGetResponsesContentApplicationJsonSchemaLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/30AutomationsGetResponsesContentApplicationJsonSchemaLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"30AutomationsGetResponsesContentApplicationJsonSchemaLinksItems"},"AutomationWorkflowLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"AutomationWorkflowLinksItemsMethod"},"AutomationWorkflowLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/AutomationWorkflowLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"AutomationWorkflowLinksItems"},"SegmentTypeItemsOneOf0ConditionType":{"type":"string","enum":["Aim"],"title":"SegmentTypeItemsOneOf0ConditionType"},"SegmentTypeItemsOneOf0Field":{"type":"string","enum":["aim"],"description":"Segment by interaction with a specific campaign.","title":"SegmentTypeItemsOneOf0Field"},"SegmentTypeItemsOneOf0Op":{"type":"string","enum":["open","click","sent","noopen","noclick","nosent"],"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.","title":"SegmentTypeItemsOneOf0Op"},"SegmentTypeItems0":{"type":"object","properties":{"condition_type":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf0ConditionType"},"field":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf0Field","description":"Segment by interaction with a specific campaign."},"op":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf0Op","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."},"value":{"type":"string","description":"Either the web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."}},"description":"Segment by interaction with a specific campaign.","title":"SegmentTypeItems0"},"SegmentTypeItemsOneOf1ConditionType":{"type":"string","enum":["Automation"],"title":"SegmentTypeItemsOneOf1ConditionType"},"SegmentTypeItemsOneOf1Field":{"type":"string","enum":["automation"],"description":"Segment by interaction with an Automation workflow.","title":"SegmentTypeItemsOneOf1Field"},"SegmentTypeItemsOneOf1Op":{"type":"string","enum":["started","completed","not_started","not_completed"],"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.","title":"SegmentTypeItemsOneOf1Op"},"SegmentTypeItems1":{"type":"object","properties":{"condition_type":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf1ConditionType"},"field":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf1Field","description":"Segment by interaction with an Automation workflow."},"op":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf1Op","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."},"value":{"type":"string","description":"The web id for the automation workflow to segment against."}},"required":["field","op","value"],"description":"Segment by interaction with an Automation workflow.","title":"SegmentTypeItems1"},"SegmentTypeItemsOneOf2ConditionType":{"type":"string","enum":["CampaignPoll"],"title":"SegmentTypeItemsOneOf2ConditionType"},"SegmentTypeItemsOneOf2Field":{"type":"string","enum":["poll"],"description":"Segment by poll activity.","title":"SegmentTypeItemsOneOf2Field"},"SegmentTypeItemsOneOf2Op":{"type":"string","enum":["member","notmember"],"description":"Members have/have not interacted with a specific poll in a Mailchimp email.","title":"SegmentTypeItemsOneOf2Op"},"SegmentTypeItems2":{"type":"object","properties":{"condition_type":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf2ConditionType"},"field":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf2Field","description":"Segment by poll activity."},"op":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf2Op","description":"Members have/have not interacted with a specific poll in a Mailchimp email."},"value":{"type":"number","format":"double","description":"The id for the poll."}},"required":["field","op","value"],"description":"Segment by poll activity.","title":"SegmentTypeItems2"},"SegmentTypeItemsOneOf3ConditionType":{"type":"string","enum":["Conversation"],"title":"SegmentTypeItemsOneOf3ConditionType"},"SegmentTypeItemsOneOf3Field":{"type":"string","enum":["conversation"],"description":"Segment by interaction with a campaign via Conversations.","title":"SegmentTypeItemsOneOf3Field"},"SegmentTypeItemsOneOf3Op":{"type":"string","enum":["member","notmember"],"description":"The status of a member's interaction with a conversation. One of the following: has replied or has not replied.","title":"SegmentTypeItemsOneOf3Op"},"SegmentTypeItems3":{"type":"object","properties":{"condition_type":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf3ConditionType"},"field":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf3Field","description":"Segment by interaction with a campaign via Conversations."},"op":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf3Op","description":"The status of a member's interaction with a conversation. One of the following: has replied or has not replied."},"value":{"type":"string","description":"The web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."}},"required":["field","op","value"],"description":"Segment by interaction with a campaign via Conversations.","title":"SegmentTypeItems3"},"SegmentTypeItemsOneOf4ConditionType":{"type":"string","enum":["Date"],"title":"SegmentTypeItemsOneOf4ConditionType"},"SegmentTypeItemsOneOf4Field":{"type":"string","enum":["timestamp_opt","info_changed","ecomm_date"],"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.","title":"SegmentTypeItemsOneOf4Field"},"SegmentTypeItemsOneOf4Op":{"type":"string","enum":["greater","less","is","not","blank","blank_not","within","notwithin"],"description":"When the event took place:  Before, after, is a specific date, is not a specific date, is blank, or is not blank.","title":"SegmentTypeItemsOneOf4Op"},"SegmentTypeItems4":{"type":"object","properties":{"condition_type":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf4ConditionType"},"extra":{"type":"string","description":"When segmenting on 'date' or 'campaign', the date for the segment formatted as YYYY-MM-DD or the web id for the campaign."},"field":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf4Field","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."},"op":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf4Op","description":"When the event took place:  Before, after, is a specific date, is not a specific date, is blank, or is not blank."},"value":{"type":"string","description":"What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."}},"required":["field","op","value"],"description":"Segment by a specific date field.","title":"SegmentTypeItems4"},"SegmentTypeItemsOneOf5ConditionType":{"type":"string","enum":["EmailClient"],"title":"SegmentTypeItemsOneOf5ConditionType"},"SegmentTypeItemsOneOf5Field":{"type":"string","enum":["email_client"],"description":"Segment by use of a particular email client.","title":"SegmentTypeItemsOneOf5Field"},"SegmentTypeItemsOneOf5Op":{"type":"string","enum":["client_is","client_not"],"description":"The operation to determine whether we select clients that match the value, or clients that do not match the value.","title":"SegmentTypeItemsOneOf5Op"},"SegmentTypeItems5":{"type":"object","properties":{"condition_type":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf5ConditionType"},"field":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf5Field","description":"Segment by use of a particular email client."},"op":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf5Op","description":"The operation to determine whether we select clients that match the value, or clients that do not match the value."},"value":{"type":"string","description":"The name of the email client."}},"required":["field","op","value"],"description":"Segment by use of a particular email client.","title":"SegmentTypeItems5"},"SegmentTypeItemsOneOf6ConditionType":{"type":"string","enum":["Language"],"title":"SegmentTypeItemsOneOf6ConditionType"},"SegmentTypeItemsOneOf6Field":{"type":"string","enum":["language"],"description":"Segmenting based off of a subscriber's language.","title":"SegmentTypeItemsOneOf6Field"},"SegmentTypeItemsOneOf6Op":{"type":"string","enum":["is","not"],"description":"Whether the member's language is or is not set to a specific language.","title":"SegmentTypeItemsOneOf6Op"},"SegmentTypeItems6":{"type":"object","properties":{"condition_type":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf6ConditionType"},"field":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf6Field","description":"Segmenting based off of a subscriber's language."},"op":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf6Op","description":"Whether the member's language is or is not set to a specific language."},"value":{"type":"string","description":"A two-letter language identifier."}},"required":["field","op","value"],"description":"Segment by language.","title":"SegmentTypeItems6"},"SegmentTypeItemsOneOf7ConditionType":{"type":"string","enum":["MemberRating"],"title":"SegmentTypeItemsOneOf7ConditionType"},"SegmentTypeItemsOneOf7Field":{"type":"string","enum":["rating"],"description":"Segment by member rating.","title":"SegmentTypeItemsOneOf7Field"},"SegmentTypeItemsOneOf7Op":{"type":"string","enum":["is","not","greater","less"],"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.","title":"SegmentTypeItemsOneOf7Op"},"SegmentTypeItemsOneOf7Value":{"oneOf":[{"type":"number","format":"double"},{"type":"string","pattern":"^\\s*[+-]?(?:[0-9]+\\.?[0-9]*|\\.[0-9]+)(?:[eE][+-]?[0-9]+)?\\s*$"}],"title":"SegmentTypeItemsOneOf7Value"},"SegmentTypeItems7":{"type":"object","properties":{"condition_type":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf7ConditionType"},"field":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf7Field","description":"Segment by member rating."},"op":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf7Op","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."},"value":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf7Value"}},"required":["field","op","value"],"description":"Segment by member rating.","title":"SegmentTypeItems7"},"SegmentTypeItemsOneOf8ConditionType":{"type":"string","enum":["SignupSource"],"title":"SegmentTypeItemsOneOf8ConditionType"},"SegmentTypeItemsOneOf8Field":{"type":"string","enum":["source"],"title":"SegmentTypeItemsOneOf8Field"},"SegmentTypeItemsOneOf8Op":{"type":"string","enum":["source_is","source_not"],"description":"Whether the member's signup source was/was not a particular value.","title":"SegmentTypeItemsOneOf8Op"},"SegmentTypeItems8":{"type":"object","properties":{"condition_type":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf8ConditionType"},"field":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf8Field"},"op":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf8Op","description":"Whether the member's signup source was/was not a particular value."},"value":{"type":"string","description":"The signup source."}},"required":["condition_type","field","op"],"description":"Segment by signup source.","title":"SegmentTypeItems8"},"SegmentTypeItemsOneOf9ConditionType":{"type":"string","enum":["SurveyMonkey"],"title":"SegmentTypeItemsOneOf9ConditionType"},"SegmentTypeItemsOneOf9Field":{"type":"string","enum":["survey_monkey"],"description":"Segment by interaction with a SurveyMonkey survey.","title":"SegmentTypeItemsOneOf9Field"},"SegmentTypeItemsOneOf9Op":{"type":"string","enum":["started","completed","not_started","not_completed"],"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.","title":"SegmentTypeItemsOneOf9Op"},"SegmentTypeItems9":{"type":"object","properties":{"condition_type":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf9ConditionType"},"field":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf9Field","description":"Segment by interaction with a SurveyMonkey survey."},"op":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf9Op","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."},"value":{"type":"string","description":"The unique ID of the survey monkey survey."}},"required":["field","op","value"],"description":"Segment by interaction with a SurveyMonkey survey.","title":"SegmentTypeItems9"},"SegmentTypeItemsOneOf10ConditionType":{"type":"string","enum":["VIP"],"title":"SegmentTypeItemsOneOf10ConditionType"},"SegmentTypeItemsOneOf10Field":{"type":"string","enum":["gmonkey"],"description":"Segment by VIP status.","title":"SegmentTypeItemsOneOf10Field"},"SegmentTypeItemsOneOf10Op":{"type":"string","enum":["member","notmember"],"description":"Whether the member is or is not marked as VIP.","title":"SegmentTypeItemsOneOf10Op"},"SegmentTypeItems10":{"type":"object","properties":{"condition_type":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf10ConditionType"},"field":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf10Field","description":"Segment by VIP status."},"op":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf10Op","description":"Whether the member is or is not marked as VIP."}},"required":["field","op"],"description":"Segment by VIP status.","title":"SegmentTypeItems10"},"SegmentTypeItemsOneOf11ConditionType":{"type":"string","enum":["Interests"],"title":"SegmentTypeItemsOneOf11ConditionType"},"SegmentTypeItemsOneOf11Op":{"type":"string","enum":["interestcontains","interestcontainsall","interestnotcontains"],"description":"Whether the member is a part of one, all, or none of the groups.","title":"SegmentTypeItemsOneOf11Op"},"SegmentTypeItems11":{"type":"object","properties":{"condition_type":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf11ConditionType"},"field":{"type":"string","description":"Segmenting based on interest group information. This should start with 'interests-' followed by the grouping id. Ex. 'interests-123'."},"op":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf11Op","description":"Whether the member is a part of one, all, or none of the groups."},"value":{"type":"array","items":{"type":"string"},"description":"An array containing strings, each representing a group id."}},"description":"Segment by an interest group merge field.","title":"SegmentTypeItems11"},"SegmentTypeItemsOneOf12ConditionType":{"type":"string","enum":["EcommCategory"],"title":"SegmentTypeItemsOneOf12ConditionType"},"SegmentTypeItemsOneOf12Field":{"type":"string","enum":["ecomm_cat","ecomm_prod"],"description":"Segment by purchases in specific items or categories.","title":"SegmentTypeItemsOneOf12Field"},"SegmentTypeItemsOneOf12Op":{"type":"string","enum":["is","not","contains","notcontain","starts","ends"],"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.","title":"SegmentTypeItemsOneOf12Op"},"SegmentTypeItems12":{"type":"object","properties":{"condition_type":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf12ConditionType"},"field":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf12Field","description":"Segment by purchases in specific items or categories."},"op":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf12Op","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."},"value":{"type":"string","description":"The ecommerce category/item information."}},"description":"Segment by purchases in specific items or categories.","title":"SegmentTypeItems12"},"SegmentTypeItemsOneOf13ConditionType":{"type":"string","enum":["EcommNumber"],"title":"SegmentTypeItemsOneOf13ConditionType"},"SegmentTypeItemsOneOf13Field":{"type":"string","enum":["ecomm_spent_avg","ecomm_orders","ecomm_prod_all","ecomm_avg_ord"],"description":"Segment by average spent total, number of orders, total number of products purchased, or average number of products per order.","title":"SegmentTypeItemsOneOf13Field"},"SegmentTypeItemsOneOf13Op":{"type":"string","enum":["is","not","greater","less"],"description":"Members who have spent exactly, have not spent exactly, spent more, or spent less than the segment value.","title":"SegmentTypeItemsOneOf13Op"},"SegmentTypeItemsOneOf13Value":{"oneOf":[{"type":"number","format":"double"},{"type":"string","pattern":"^\\s*[+-]?(?:[0-9]+\\.?[0-9]*|\\.[0-9]+)(?:[eE][+-]?[0-9]+)?\\s*$"}],"title":"SegmentTypeItemsOneOf13Value"},"SegmentTypeItems13":{"type":"object","properties":{"condition_type":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf13ConditionType"},"field":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf13Field","description":"Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."},"op":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf13Op","description":"Members who have spent exactly, have not spent exactly, spent more, or spent less than the segment value."},"value":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf13Value"}},"required":["field","op","value"],"description":"Segment by average spent total, number of orders, total number of products purchased, or average number of products per order.","title":"SegmentTypeItems13"},"SegmentTypeItemsOneOf14ConditionType":{"type":"string","enum":["EcommPurchased"],"title":"SegmentTypeItemsOneOf14ConditionType"},"SegmentTypeItemsOneOf14Field":{"type":"string","enum":["ecomm_purchased"],"description":"Segment by whether someone has purchased anything.","title":"SegmentTypeItemsOneOf14Field"},"SegmentTypeItemsOneOf14Op":{"type":"string","enum":["member","notmember"],"description":"Members who have have ('member') or have not ('notmember') purchased.","title":"SegmentTypeItemsOneOf14Op"},"SegmentTypeItems14":{"type":"object","properties":{"condition_type":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf14ConditionType"},"field":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf14Field","description":"Segment by whether someone has purchased anything."},"op":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf14Op","description":"Members who have have ('member') or have not ('notmember') purchased."}},"description":"Segment by whether someone has purchased anything.","title":"SegmentTypeItems14"},"SegmentTypeItemsOneOf15ConditionType":{"type":"string","enum":["EcommSpent"],"title":"SegmentTypeItemsOneOf15ConditionType"},"SegmentTypeItemsOneOf15Field":{"type":"string","enum":["ecomm_spent_one","ecomm_spent_all"],"description":"Segment by amount spent on a single order or across all orders.","title":"SegmentTypeItemsOneOf15Field"},"SegmentTypeItemsOneOf15Op":{"type":"string","enum":["greater","less"],"description":"Members who have spent 'more' or 'less' than then specified value.","title":"SegmentTypeItemsOneOf15Op"},"SegmentTypeItemsOneOf15Value":{"oneOf":[{"type":"number","format":"double"},{"type":"string","pattern":"^\\s*[+-]?(?:[0-9]+\\.?[0-9]*|\\.[0-9]+)(?:[eE][+-]?[0-9]+)?\\s*$"}],"title":"SegmentTypeItemsOneOf15Value"},"SegmentTypeItems15":{"type":"object","properties":{"condition_type":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf15ConditionType"},"field":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf15Field","description":"Segment by amount spent on a single order or across all orders."},"op":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf15Op","description":"Members who have spent 'more' or 'less' than then specified value."},"value":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf15Value"}},"description":"Segment by amount spent on a single order or across all orders.","title":"SegmentTypeItems15"},"SegmentTypeItemsOneOf16ConditionType":{"type":"string","enum":["EcommStore"],"title":"SegmentTypeItemsOneOf16ConditionType"},"SegmentTypeItemsOneOf16Field":{"type":"string","enum":["ecomm_store"],"description":"Segment by purchases from a specific store.","title":"SegmentTypeItemsOneOf16Field"},"SegmentTypeItemsOneOf16Op":{"type":"string","enum":["is","not"],"description":"Members who have or have not purchased from a specific store.","title":"SegmentTypeItemsOneOf16Op"},"SegmentTypeItems16":{"type":"object","properties":{"condition_type":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf16ConditionType"},"field":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf16Field","description":"Segment by purchases from a specific store."},"op":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf16Op","description":"Members who have or have not purchased from a specific store."},"value":{"type":"string","description":"The store id to segment against."}},"description":"Segment by purchases from a specific store.","title":"SegmentTypeItems16"},"SegmentTypeItemsOneOf17ConditionType":{"type":"string","enum":["GoalActivity"],"title":"SegmentTypeItemsOneOf17ConditionType"},"SegmentTypeItemsOneOf17Field":{"type":"string","enum":["goal"],"description":"Segment by Goal activity.","title":"SegmentTypeItemsOneOf17Field"},"SegmentTypeItemsOneOf17Op":{"type":"string","enum":["is","goal_not","contains","goal_notcontain","starts","ends"],"description":"Whether the website URL is/not exactly, contains/doesn't contain, starts with/ends with a string.","title":"SegmentTypeItemsOneOf17Op"},"SegmentTypeItems17":{"type":"object","properties":{"condition_type":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf17ConditionType"},"field":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf17Field","description":"Segment by Goal activity."},"op":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf17Op","description":"Whether the website URL is/not exactly, contains/doesn't contain, starts with/ends with a string."},"value":{"type":"string","description":"The URL to check Goal activity against."}},"required":["field","op","value"],"description":"Segment by Goal activity.","title":"SegmentTypeItems17"},"SegmentTypeItemsOneOf18ConditionType":{"type":"string","enum":["GoalTimestamp"],"title":"SegmentTypeItemsOneOf18ConditionType"},"SegmentTypeItemsOneOf18Field":{"type":"string","enum":["goal_last_visited"],"description":"Segment by most recent interaction with a website.","title":"SegmentTypeItemsOneOf18Field"},"SegmentTypeItemsOneOf18Op":{"type":"string","enum":["greater","less","is"],"description":"Whether the website activity happened after, before, or at a given timestamp.","title":"SegmentTypeItemsOneOf18Op"},"SegmentTypeItems18":{"type":"object","properties":{"condition_type":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf18ConditionType"},"field":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf18Field","description":"Segment by most recent interaction with a website."},"op":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf18Op","description":"Whether the website activity happened after, before, or at a given timestamp."},"value":{"type":"string","description":"The date to check Goal activity against."}},"required":["field","op","value"],"description":"Segment by most recent interaction with a website.","title":"SegmentTypeItems18"},"SegmentTypeItemsOneOf19ConditionType":{"type":"string","enum":["FuzzySegment"],"title":"SegmentTypeItemsOneOf19ConditionType"},"SegmentTypeItemsOneOf19Field":{"type":"string","enum":["fuzzy_segment"],"description":"Segment by similar subscribers.","title":"SegmentTypeItemsOneOf19Field"},"SegmentTypeItemsOneOf19Op":{"type":"string","enum":["fuzzy_is","fuzzy_not"],"description":"Members who are/are not apart of a 'similar subscribers' segment.","title":"SegmentTypeItemsOneOf19Op"},"SegmentTypeItemsOneOf19Value":{"oneOf":[{"type":"number","format":"double"},{"type":"string","pattern":"^\\s*[+-]?(?:[0-9]+\\.?[0-9]*|\\.[0-9]+)(?:[eE][+-]?[0-9]+)?\\s*$"}],"title":"SegmentTypeItemsOneOf19Value"},"SegmentTypeItems19":{"type":"object","properties":{"condition_type":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf19ConditionType"},"field":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf19Field","description":"Segment by similar subscribers."},"op":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf19Op","description":"Members who are/are not apart of a 'similar subscribers' segment."},"value":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf19Value"}},"required":["field","op","value"],"description":"Segment by similar subscribers.","title":"SegmentTypeItems19"},"SegmentTypeItemsOneOf20ConditionType":{"type":"string","enum":["StaticSegment"],"title":"SegmentTypeItemsOneOf20ConditionType"},"SegmentTypeItemsOneOf20Field":{"type":"string","enum":["static_segment"],"description":"Segment by a given static segment.","title":"SegmentTypeItemsOneOf20Field"},"SegmentTypeItemsOneOf20Op":{"type":"string","enum":["static_is","static_not"],"description":"Members who are/are not apart of a static segment.","title":"SegmentTypeItemsOneOf20Op"},"SegmentTypeItemsOneOf20Value":{"oneOf":[{"type":"number","format":"double"},{"type":"string","pattern":"^\\s*[+-]?(?:[0-9]+\\.?[0-9]*|\\.[0-9]+)(?:[eE][+-]?[0-9]+)?\\s*$"}],"title":"SegmentTypeItemsOneOf20Value"},"SegmentTypeItems20":{"type":"object","properties":{"condition_type":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf20ConditionType"},"field":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf20Field","description":"Segment by a given static segment."},"op":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf20Op","description":"Members who are/are not apart of a static segment."},"value":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf20Value"}},"required":["field","op","value"],"description":"Segment by a given static segment.","title":"SegmentTypeItems20"},"SegmentTypeItemsOneOf21ConditionType":{"type":"string","enum":["IPGeoCountryState"],"title":"SegmentTypeItemsOneOf21ConditionType"},"SegmentTypeItemsOneOf21Field":{"type":"string","enum":["ipgeo"],"description":"Segmenting subscribers who are within a specific location.","title":"SegmentTypeItemsOneOf21Field"},"SegmentTypeItemsOneOf21Op":{"type":"string","enum":["ipgeocountry","ipgeonotcountry","ipgeostate","ipgeonotstate"],"description":"Segment members who are within a specific country or US state.","title":"SegmentTypeItemsOneOf21Op"},"SegmentTypeItems21":{"type":"object","properties":{"condition_type":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf21ConditionType"},"field":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf21Field","description":"Segmenting subscribers who are within a specific location."},"op":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf21Op","description":"Segment members who are within a specific country or US state."},"value":{"type":"string","description":"The two-letter country code or US state abbreviation."}},"required":["field","op","value"],"description":"Segment by a specific country or US state.","title":"SegmentTypeItems21"},"SegmentTypeItemsOneOf22ConditionType":{"type":"string","enum":["IPGeoIn"],"title":"SegmentTypeItemsOneOf22ConditionType"},"SegmentTypeItemsOneOf22Field":{"type":"string","enum":["ipgeo"],"description":"Segmenting subscribers who are within a specific location.","title":"SegmentTypeItemsOneOf22Field"},"SegmentTypeItemsOneOf22Op":{"type":"string","enum":["ipgeoin","ipgeonotin"],"description":"Segment members who are within a specific geographic region.","title":"SegmentTypeItemsOneOf22Op"},"SegmentTypeItems22":{"type":"object","properties":{"addr":{"type":"string","description":"The address of the target location."},"condition_type":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf22ConditionType"},"field":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf22Field","description":"Segmenting subscribers who are within a specific location."},"lat":{"type":"string","description":"The latitude of the target location."},"lng":{"type":"string","description":"The longitude of the target location."},"op":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf22Op","description":"Segment members who are within a specific geographic region."},"value":{"type":"integer","description":"The radius of the target location."}},"required":["addr","field","lat","lng","op","value"],"description":"Segment by a specific geographic region.","title":"SegmentTypeItems22"},"SegmentTypeItemsOneOf23ConditionType":{"type":"string","enum":["IPGeoInZip"],"title":"SegmentTypeItemsOneOf23ConditionType"},"SegmentTypeItemsOneOf23Field":{"type":"string","enum":["ipgeo"],"description":"Segmenting subscribers who are within a specific location.","title":"SegmentTypeItemsOneOf23Field"},"SegmentTypeItemsOneOf23Op":{"type":"string","enum":["ipgeoinzip"],"description":"Segment members who are within a specific US zip code.","title":"SegmentTypeItemsOneOf23Op"},"SegmentTypeItems23":{"type":"object","properties":{"condition_type":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf23ConditionType"},"extra":{"type":"integer","description":"The zip code to segment against."},"field":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf23Field","description":"Segmenting subscribers who are within a specific location."},"op":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf23Op","description":"Segment members who are within a specific US zip code."},"value":{"type":"integer","description":"The radius of the target location."}},"required":["extra","field","op","value"],"description":"Segment by a specific US ZIP code.","title":"SegmentTypeItems23"},"SegmentTypeItemsOneOf24ConditionType":{"type":"string","enum":["IPGeoUnknown"],"title":"SegmentTypeItemsOneOf24ConditionType"},"SegmentTypeItemsOneOf24Field":{"type":"string","enum":["ipgeo"],"description":"Segmenting subscribers who are within a specific location.","title":"SegmentTypeItemsOneOf24Field"},"SegmentTypeItemsOneOf24Op":{"type":"string","enum":["ipgeounknown"],"description":"Segment members for which location information is unknown.","title":"SegmentTypeItemsOneOf24Op"},"SegmentTypeItems24":{"type":"object","properties":{"condition_type":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf24ConditionType"},"field":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf24Field","description":"Segmenting subscribers who are within a specific location."},"op":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf24Op","description":"Segment members for which location information is unknown."}},"required":["field","op"],"description":"Segment members whose location information is unknown.","title":"SegmentTypeItems24"},"SegmentTypeItemsOneOf25ConditionType":{"type":"string","enum":["IPGeoZip"],"title":"SegmentTypeItemsOneOf25ConditionType"},"SegmentTypeItemsOneOf25Field":{"type":"string","enum":["ipgeo"],"description":"Segmenting subscribers who are within a specific location.","title":"SegmentTypeItemsOneOf25Field"},"SegmentTypeItemsOneOf25Op":{"type":"string","enum":["ipgeoiszip","ipgeonotzip"],"description":"Segment members who are/are not within a specific US zip code.","title":"SegmentTypeItemsOneOf25Op"},"SegmentTypeItems25":{"type":"object","properties":{"condition_type":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf25ConditionType"},"field":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf25Field","description":"Segmenting subscribers who are within a specific location."},"op":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf25Op","description":"Segment members who are/are not within a specific US zip code."},"value":{"type":"integer","description":"The 5-digit zip code."}},"required":["field","op","value"],"description":"Segment by a specific US ZIP code.","title":"SegmentTypeItems25"},"SegmentTypeItemsOneOf26ConditionType":{"type":"string","enum":["SocialAge"],"title":"SegmentTypeItemsOneOf26ConditionType"},"SegmentTypeItemsOneOf26Field":{"type":"string","enum":["social_age"],"description":"Segment by age ranges in Social Profiles data.","title":"SegmentTypeItemsOneOf26Field"},"SegmentTypeItemsOneOf26Op":{"type":"string","enum":["is","not"],"description":"Members who are/not the exact criteria listed.","title":"SegmentTypeItemsOneOf26Op"},"SegmentTypeItemsOneOf26Value":{"type":"string","enum":["18-24","25-34","35-54","55+"],"description":"The age range to segment.","title":"SegmentTypeItemsOneOf26Value"},"SegmentTypeItems26":{"type":"object","properties":{"condition_type":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf26ConditionType"},"field":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf26Field","description":"Segment by age ranges in Social Profiles data."},"op":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf26Op","description":"Members who are/not the exact criteria listed."},"value":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf26Value","description":"The age range to segment."}},"required":["field","op","value"],"description":"Segment by age ranges in Social Profiles data.","title":"SegmentTypeItems26"},"SegmentTypeItemsOneOf27ConditionType":{"type":"string","enum":["SocialGender"],"title":"SegmentTypeItemsOneOf27ConditionType"},"SegmentTypeItemsOneOf27Field":{"type":"string","enum":["social_gender"],"description":"Segment by listed gender in Social Profiles data.","title":"SegmentTypeItemsOneOf27Field"},"SegmentTypeItemsOneOf27Op":{"type":"string","enum":["is","not"],"description":"Members who are/not the exact criteria listed.","title":"SegmentTypeItemsOneOf27Op"},"SegmentTypeItemsOneOf27Value":{"type":"string","enum":["male","female"],"description":"The Social Profiles gender to segment.","title":"SegmentTypeItemsOneOf27Value"},"SegmentTypeItems27":{"type":"object","properties":{"condition_type":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf27ConditionType"},"field":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf27Field","description":"Segment by listed gender in Social Profiles data."},"op":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf27Op","description":"Members who are/not the exact criteria listed."},"value":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf27Value","description":"The Social Profiles gender to segment."}},"required":["field","op","value"],"description":"Segment by listed gender in Social Profiles data.","title":"SegmentTypeItems27"},"SegmentTypeItemsOneOf28ConditionType":{"type":"string","enum":["SocialInfluence"],"title":"SegmentTypeItemsOneOf28ConditionType"},"SegmentTypeItemsOneOf28Field":{"type":"string","enum":["social_influence"],"description":"Segment by influence rating in Social Profiles data.","title":"SegmentTypeItemsOneOf28Field"},"SegmentTypeItemsOneOf28Op":{"type":"string","enum":["is","not","greater","less"],"description":"Members who have a rating that is/not or greater/less than the rating provided.","title":"SegmentTypeItemsOneOf28Op"},"SegmentTypeItems28":{"type":"object","properties":{"condition_type":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf28ConditionType"},"field":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf28Field","description":"Segment by influence rating in Social Profiles data."},"op":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf28Op","description":"Members who have a rating that is/not or greater/less than the rating provided."},"value":{"type":"number","format":"double","description":"The Social Profiles influence rating to segment."}},"required":["field","op","value"],"description":"Segment by influence rating in Social Profiles data.","title":"SegmentTypeItems28"},"SegmentTypeItemsOneOf29ConditionType":{"type":"string","enum":["SocialNetworkMember"],"title":"SegmentTypeItemsOneOf29ConditionType"},"SegmentTypeItemsOneOf29Field":{"type":"string","enum":["social_network"],"description":"Segment by social network in Social Profiles data.","title":"SegmentTypeItemsOneOf29Field"},"SegmentTypeItemsOneOf29Op":{"type":"string","enum":["member","notmember"],"description":"Members who are/not on a given social network.","title":"SegmentTypeItemsOneOf29Op"},"SegmentTypeItemsOneOf29Value":{"type":"string","enum":["twitter","facebook","linkedin","flickr","foursquare","lastfm","myspace","quora","vimeo","yelp","youtube"],"description":"The social network to segment against.","title":"SegmentTypeItemsOneOf29Value"},"SegmentTypeItems29":{"type":"object","properties":{"condition_type":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf29ConditionType"},"field":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf29Field","description":"Segment by social network in Social Profiles data."},"op":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf29Op","description":"Members who are/not on a given social network."},"value":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf29Value","description":"The social network to segment against."}},"required":["field","op","value"],"description":"Segment by social network in Social Profiles data.","title":"SegmentTypeItems29"},"SegmentTypeItemsOneOf30ConditionType":{"type":"string","enum":["SocialNetworkFollow"],"title":"SegmentTypeItemsOneOf30ConditionType"},"SegmentTypeItemsOneOf30Field":{"type":"string","enum":["social_network"],"description":"Segment by social network in Social Profiles data.","title":"SegmentTypeItemsOneOf30Field"},"SegmentTypeItemsOneOf30Op":{"type":"string","enum":["follow","notfollow"],"description":"Members who are/not following a linked account on a given social network.","title":"SegmentTypeItemsOneOf30Op"},"SegmentTypeItemsOneOf30Value":{"type":"string","enum":["twitter_follow"],"description":"The social network to segment against.","title":"SegmentTypeItemsOneOf30Value"},"SegmentTypeItems30":{"type":"object","properties":{"condition_type":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf30ConditionType"},"field":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf30Field","description":"Segment by social network in Social Profiles data."},"op":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf30Op","description":"Members who are/not following a linked account on a given social network."},"value":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf30Value","description":"The social network to segment against."}},"required":["field","op","value"],"description":"Segment by social network in Social Profiles data.","title":"SegmentTypeItems30"},"SegmentTypeItemsOneOf31ConditionType":{"type":"string","enum":["AddressMerge"],"title":"SegmentTypeItemsOneOf31ConditionType"},"SegmentTypeItemsOneOf31Op":{"type":"string","enum":["contains","notcontain","blank","blank_not"],"description":"Whether the member's address merge field contains/does not contain a value or is/is not blank.","title":"SegmentTypeItemsOneOf31Op"},"SegmentTypeItems31":{"type":"object","properties":{"condition_type":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf31ConditionType"},"field":{"type":"string","description":"An address-type merge field to segment."},"op":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf31Op","description":"Whether the member's address merge field contains/does not contain a value or is/is not blank."},"value":{"type":"string","description":"The value to segment a text merge field with."}},"required":["field","op"],"description":"Segment by an address-type merge field.","title":"SegmentTypeItems31"},"SegmentTypeItemsOneOf32ConditionType":{"type":"string","enum":["ZipMerge"],"title":"SegmentTypeItemsOneOf32ConditionType"},"SegmentTypeItemsOneOf32Op":{"type":"string","enum":["geoin"],"description":"Whether the member's address merge field is within a given distance from a city or zip.","title":"SegmentTypeItemsOneOf32Op"},"SegmentTypeItems32":{"type":"object","properties":{"condition_type":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf32ConditionType"},"extra":{"type":"string","description":"The city or the zip being used to segment against."},"field":{"type":"string","description":"An address or zip-type merge field to segment."},"op":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf32Op","description":"Whether the member's address merge field is within a given distance from a city or zip."},"value":{"type":"string","description":"The distance from the city/zip."}},"required":["extra","field","op","value"],"description":"Segment by an address-type merge field within a given distance.","title":"SegmentTypeItems32"},"SegmentTypeItemsOneOf33ConditionType":{"type":"string","enum":["BirthdayMerge"],"title":"SegmentTypeItemsOneOf33ConditionType"},"SegmentTypeItemsOneOf33Op":{"type":"string","enum":["is","not","blank","blank_not"],"description":"Whether the member's birthday merge information is/is not a certain date or is/is not blank.","title":"SegmentTypeItemsOneOf33Op"},"SegmentTypeItems33":{"type":"object","properties":{"condition_type":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf33ConditionType"},"field":{"type":"string","description":"A date merge field to segment."},"op":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf33Op","description":"Whether the member's birthday merge information is/is not a certain date or is/is not blank."},"value":{"type":"string","description":"A date to segment against (mm/dd)."}},"required":["field","op"],"description":"Segment by a contact's birthday.","title":"SegmentTypeItems33"},"SegmentTypeItemsOneOf34ConditionType":{"type":"string","enum":["DateMerge"],"title":"SegmentTypeItemsOneOf34ConditionType"},"SegmentTypeItemsOneOf34Op":{"type":"string","enum":["is","not","less","blank","blank_not","greater"],"description":"Whether the member's merge information is/is not, is greater/less than a value or is/is not blank.","title":"SegmentTypeItemsOneOf34Op"},"SegmentTypeItems34":{"type":"object","properties":{"condition_type":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf34ConditionType"},"field":{"type":"string","description":"A date merge field to segment."},"op":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf34Op","description":"Whether the member's merge information is/is not, is greater/less than a value or is/is not blank."},"value":{"type":"string","description":"A date to segment against."}},"required":["field","op"],"description":"Segment by a given date merge field.","title":"SegmentTypeItems34"},"SegmentTypeItemsOneOf35ConditionType":{"type":"string","enum":["SelectMerge"],"title":"SegmentTypeItemsOneOf35ConditionType"},"SegmentTypeItemsOneOf35Op":{"type":"string","enum":["is","not","blank","blank_not","notcontain","contains"],"description":"Whether the member's merge information is/is not a value or is/is not blank.","title":"SegmentTypeItemsOneOf35Op"},"SegmentTypeItems35":{"type":"object","properties":{"condition_type":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf35ConditionType"},"field":{"type":"string","description":"A merge field to segment."},"op":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf35Op","description":"Whether the member's merge information is/is not a value or is/is not blank."},"value":{"type":"string","description":"The value to segment a text merge field with."}},"required":["field","op"],"description":"An individual segment condition","title":"SegmentTypeItems35"},"SegmentTypeItemsOneOf36ConditionType":{"type":"string","enum":["TextMerge"],"title":"SegmentTypeItemsOneOf36ConditionType"},"SegmentTypeItemsOneOf36Op":{"type":"string","enum":["is","not","contains","notcontain","starts","ends","greater","less","blank","blank_not"],"description":"Whether the member's merge information is/is not, contains/does not contain, starts/ends with, or is greater/less than a value","title":"SegmentTypeItemsOneOf36Op"},"SegmentTypeItems36":{"type":"object","properties":{"condition_type":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf36ConditionType"},"field":{"type":"string","description":"A text or number merge field to segment."},"op":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf36Op","description":"Whether the member's merge information is/is not, contains/does not contain, starts/ends with, or is greater/less than a value"},"value":{"type":"string","description":"The value to segment a text or number merge field with."}},"required":["field","op"],"description":"Segment by a given text or number merge field.","title":"SegmentTypeItems36"},"SegmentTypeItemsOneOf37ConditionType":{"type":"string","enum":["EmailAddress"],"title":"SegmentTypeItemsOneOf37ConditionType"},"SegmentTypeItemsOneOf37Field":{"type":"string","enum":["merge0","EMAIL"],"description":"Segmenting based off of a subscriber's email address.","title":"SegmentTypeItemsOneOf37Field"},"SegmentTypeItemsOneOf37Op":{"type":"string","enum":["is","not","contains","notcontain","starts","ends","greater","less"],"description":"Whether the email address is/not exactly, contains/doesn't contain, starts/ends with a string.","title":"SegmentTypeItemsOneOf37Op"},"SegmentTypeItems37":{"type":"object","properties":{"condition_type":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf37ConditionType"},"field":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf37Field","description":"Segmenting based off of a subscriber's email address."},"op":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf37Op","description":"Whether the email address is/not exactly, contains/doesn't contain, starts/ends with a string."},"value":{"type":"string","description":"The value to compare the email against."}},"required":["field","op"],"description":"Segment by email address.","title":"SegmentTypeItems37"},"SegmentTypeItemsOneOf38ConditionType":{"type":"string","enum":["PredictedGender"],"title":"SegmentTypeItemsOneOf38ConditionType"},"SegmentTypeItemsOneOf38Field":{"type":"string","enum":["predicted_gender"],"description":"Segment by predicted gender.","title":"SegmentTypeItemsOneOf38Field"},"SegmentTypeItemsOneOf38Op":{"type":"string","enum":["is","not"],"description":"Members who are/not the exact criteria listed.","title":"SegmentTypeItemsOneOf38Op"},"SegmentTypeItemsOneOf38Value":{"type":"string","enum":["male","female"],"description":"The predicted gender to segment.","title":"SegmentTypeItemsOneOf38Value"},"SegmentTypeItems38":{"type":"object","properties":{"condition_type":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf38ConditionType"},"field":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf38Field","description":"Segment by predicted gender."},"op":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf38Op","description":"Members who are/not the exact criteria listed."},"value":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf38Value","description":"The predicted gender to segment."}},"required":["field","op","value"],"description":"Segment by predicted gender.","title":"SegmentTypeItems38"},"SegmentTypeItemsOneOf39ConditionType":{"type":"string","enum":["PredictedAge"],"title":"SegmentTypeItemsOneOf39ConditionType"},"SegmentTypeItemsOneOf39Field":{"type":"string","enum":["predicted_age_range"],"description":"Segment by predicted age.","title":"SegmentTypeItemsOneOf39Field"},"SegmentTypeItemsOneOf39Op":{"type":"string","enum":["is"],"description":"Members who are/not the exact criteria listed.","title":"SegmentTypeItemsOneOf39Op"},"SegmentTypeItemsOneOf39Value":{"type":"string","enum":["18-24","25-34","35-44","45-54","55-64","65+"],"description":"The predicted age to segment.","title":"SegmentTypeItemsOneOf39Value"},"SegmentTypeItems39":{"type":"object","properties":{"condition_type":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf39ConditionType"},"field":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf39Field","description":"Segment by predicted age."},"op":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf39Op","description":"Members who are/not the exact criteria listed."},"value":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf39Value","description":"The predicted age to segment."}},"required":["field","op","value"],"description":"Segment by predicted age.","title":"SegmentTypeItems39"},"SegmentTypeItemsOneOf40ConditionType":{"type":"string","enum":["NewSubscribers"],"title":"SegmentTypeItemsOneOf40ConditionType"},"SegmentTypeItemsOneOf40Field":{"type":"string","enum":["timestamp_opt"],"description":"Segment by when people subscribed.","title":"SegmentTypeItemsOneOf40Field"},"SegmentTypeItemsOneOf40Op":{"type":"string","enum":["date_within"],"description":"Whe the event took place, namely within a time frame.","title":"SegmentTypeItemsOneOf40Op"},"SegmentTypeItems40":{"type":"object","properties":{"condition_type":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf40ConditionType"},"field":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf40Field","description":"Segment by when people subscribed."},"op":{"$ref":"#/components/schemas/SegmentTypeItemsOneOf40Op","description":"Whe the event took place, namely within a time frame."},"value":{"type":"string","description":"What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."}},"description":"Segment by when people subscribed.","title":"SegmentTypeItems40"},"SegmentTypeItems":{"oneOf":[{"$ref":"#/components/schemas/SegmentTypeItems0"},{"$ref":"#/components/schemas/SegmentTypeItems1"},{"$ref":"#/components/schemas/SegmentTypeItems2"},{"$ref":"#/components/schemas/SegmentTypeItems3"},{"$ref":"#/components/schemas/SegmentTypeItems4"},{"$ref":"#/components/schemas/SegmentTypeItems5"},{"$ref":"#/components/schemas/SegmentTypeItems6"},{"$ref":"#/components/schemas/SegmentTypeItems7"},{"$ref":"#/components/schemas/SegmentTypeItems8"},{"$ref":"#/components/schemas/SegmentTypeItems9"},{"$ref":"#/components/schemas/SegmentTypeItems10"},{"$ref":"#/components/schemas/SegmentTypeItems11"},{"$ref":"#/components/schemas/SegmentTypeItems12"},{"$ref":"#/components/schemas/SegmentTypeItems13"},{"$ref":"#/components/schemas/SegmentTypeItems14"},{"$ref":"#/components/schemas/SegmentTypeItems15"},{"$ref":"#/components/schemas/SegmentTypeItems16"},{"$ref":"#/components/schemas/SegmentTypeItems17"},{"$ref":"#/components/schemas/SegmentTypeItems18"},{"$ref":"#/components/schemas/SegmentTypeItems19"},{"$ref":"#/components/schemas/SegmentTypeItems20"},{"$ref":"#/components/schemas/SegmentTypeItems21"},{"$ref":"#/components/schemas/SegmentTypeItems22"},{"$ref":"#/components/schemas/SegmentTypeItems23"},{"$ref":"#/components/schemas/SegmentTypeItems24"},{"$ref":"#/components/schemas/SegmentTypeItems25"},{"$ref":"#/components/schemas/SegmentTypeItems26"},{"$ref":"#/components/schemas/SegmentTypeItems27"},{"$ref":"#/components/schemas/SegmentTypeItems28"},{"$ref":"#/components/schemas/SegmentTypeItems29"},{"$ref":"#/components/schemas/SegmentTypeItems30"},{"$ref":"#/components/schemas/SegmentTypeItems31"},{"$ref":"#/components/schemas/SegmentTypeItems32"},{"$ref":"#/components/schemas/SegmentTypeItems33"},{"$ref":"#/components/schemas/SegmentTypeItems34"},{"$ref":"#/components/schemas/SegmentTypeItems35"},{"$ref":"#/components/schemas/SegmentTypeItems36"},{"$ref":"#/components/schemas/SegmentTypeItems37"},{"$ref":"#/components/schemas/SegmentTypeItems38"},{"$ref":"#/components/schemas/SegmentTypeItems39"},{"$ref":"#/components/schemas/SegmentTypeItems40"}],"title":"SegmentTypeItems"},"SegmentType":{"type":"array","items":{"$ref":"#/components/schemas/SegmentTypeItems"},"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).","title":"SegmentType"},"AutomationWorkflowRecipients":{"type":"object","properties":{"list_id":{"type":"string","description":"The unique list id."},"list_is_active":{"type":"boolean","description":"The status of the list used, namely if it's deleted or disabled."},"list_name":{"type":"string","description":"List Name."},"segment_opts":{"$ref":"#/components/schemas/SegmentType"},"store_id":{"type":"string","description":"The id of the store."}},"description":"List settings for the Automation.","title":"AutomationWorkflowRecipients"},"AutomationWorkflowReportSummary":{"type":"object","properties":{"click_rate":{"type":"number","format":"double","description":"The number of unique clicks, divided by the total number of successful deliveries."},"clicks":{"type":"integer","description":"The total number of clicks for an campaign."},"open_rate":{"type":"number","format":"double","description":"The number of unique opens divided by the total number of successful deliveries."},"opens":{"type":"integer","description":"The total number of opens for a campaign."},"subscriber_clicks":{"type":"integer","description":"The number of unique clicks."},"unique_opens":{"type":"integer","description":"The number of unique opens."}},"description":"A summary of opens and clicks for sent campaigns.","title":"AutomationWorkflowReportSummary"},"AutomationWorkflowSettings":{"type":"object","properties":{"authenticate":{"type":"boolean","description":"Whether Mailchimp [authenticated](https://mailchimp.com/help/about-email-authentication/) the Automation. Defaults to `true`."},"auto_footer":{"type":"boolean","description":"Whether to automatically append Mailchimp's [default footer](https://mailchimp.com/help/about-campaign-footers/) to the Automation."},"from_name":{"type":"string","description":"The 'from' name for the Automation (not an email address)."},"inline_css":{"type":"boolean","description":"Whether to automatically inline the CSS included with the Automation content."},"reply_to":{"type":"string","description":"The reply-to email address for the Automation."},"title":{"type":"string","description":"The title of the Automation."},"to_name":{"type":"string","description":"The Automation's custom 'To' name, typically the first name [audience field](https://mailchimp.com/help/getting-started-with-merge-tags/)."},"use_conversation":{"type":"boolean","description":"Whether to use Mailchimp Conversation feature to manage replies"}},"description":"The settings for the Automation workflow.","title":"AutomationWorkflowSettings"},"AutomationWorkflowStatus":{"type":"string","enum":["save","paused","sending"],"description":"The current status of the Automation.","title":"AutomationWorkflowStatus"},"AutomationWorkflowTrackingCapsule":{"type":"object","properties":{"notes":{"type":"boolean","description":"Update contact notes for a campaign based on a subscriber's email addresses."}},"description":"Deprecated","title":"AutomationWorkflowTrackingCapsule"},"AutomationWorkflowTrackingSalesforce":{"type":"object","properties":{"campaign":{"type":"boolean","description":"Create a campaign in a connected Salesforce account."},"notes":{"type":"boolean","description":"Update contact notes for a campaign based on a subscriber's email address."}},"description":"Deprecated","title":"AutomationWorkflowTrackingSalesforce"},"AutomationWorkflowTracking":{"type":"object","properties":{"capsule":{"$ref":"#/components/schemas/AutomationWorkflowTrackingCapsule","description":"Deprecated"},"clicktale":{"type":"string","description":"The custom slug for [ClickTale](https://mailchimp.com/help/additional-tracking-options-for-campaigns/) tracking (max of 50 bytes)."},"ecomm360":{"type":"boolean","description":"Whether to enable e-commerce tracking."},"goal_tracking":{"type":"boolean","description":"Deprecated"},"google_analytics":{"type":"string","description":"The custom slug for [Google Analytics](https://mailchimp.com/help/integrate-google-analytics-with-mailchimp/) tracking (max of 50 bytes)."},"html_clicks":{"type":"boolean","description":"Whether to [track clicks](https://mailchimp.com/help/enable-and-view-click-tracking/) in the HTML version of the Automation. Defaults to `true`."},"opens":{"type":"boolean","description":"Whether to [track opens](https://mailchimp.com/help/about-open-tracking/). Defaults to `true`."},"salesforce":{"$ref":"#/components/schemas/AutomationWorkflowTrackingSalesforce","description":"Deprecated"},"text_clicks":{"type":"boolean","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`."}},"description":"The tracking options for the Automation.","title":"AutomationWorkflowTracking"},"AutomationWorkflowTriggerSettingsRuntimeDaysItems":{"type":"string","enum":["sunday","monday","tuesday","wednesday","thursday","friday","saturday"],"title":"AutomationWorkflowTriggerSettingsRuntimeDaysItems"},"AutomationWorkflowTriggerSettingsRuntimeHoursType":{"type":"string","enum":["send_asap","send_between","send_at"],"description":"When to send the Automation email.","title":"AutomationWorkflowTriggerSettingsRuntimeHoursType"},"AutomationWorkflowTriggerSettingsRuntimeHours":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/AutomationWorkflowTriggerSettingsRuntimeHoursType","description":"When to send the Automation email."}},"required":["type"],"description":"The hours an Automation workflow can send.","title":"AutomationWorkflowTriggerSettingsRuntimeHours"},"AutomationWorkflowTriggerSettingsRuntime":{"type":"object","properties":{"days":{"type":"array","items":{"$ref":"#/components/schemas/AutomationWorkflowTriggerSettingsRuntimeDaysItems"},"description":"The days an Automation workflow can send."},"hours":{"$ref":"#/components/schemas/AutomationWorkflowTriggerSettingsRuntimeHours","description":"The hours an Automation workflow can send."}},"description":"A workflow's runtime settings for an Automation.","title":"AutomationWorkflowTriggerSettingsRuntime"},"AutomationWorkflowTriggerSettingsWorkflowType":{"type":"string","enum":["abandonedBrowse","abandonedCart","api","bestCustomers","categoryFollowup","dateAdded","emailFollowup","emailSeries","groupAdd","groupRemove","mandrill","productFollowup","purchaseFollowup","recurringEvent","specialEvent","visitUrl","welcomeSeries"],"description":"The type of Automation workflow.","title":"AutomationWorkflowTriggerSettingsWorkflowType"},"AutomationWorkflowTriggerSettings":{"type":"object","properties":{"runtime":{"$ref":"#/components/schemas/AutomationWorkflowTriggerSettingsRuntime","description":"A workflow's runtime settings for an Automation."},"workflow_emails_count":{"type":"integer","description":"The number of emails in the Automation workflow."},"workflow_title":{"type":"string","description":"The title of the workflow type."},"workflow_type":{"$ref":"#/components/schemas/AutomationWorkflowTriggerSettingsWorkflowType","description":"The type of Automation workflow."}},"required":["workflow_type"],"description":"Available triggers for Automation workflows.","title":"AutomationWorkflowTriggerSettings"},"AutomationWorkflow":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/AutomationWorkflowLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"create_time":{"type":"string","format":"date-time","description":"The date and time the Automation was created in ISO 8601 format."},"emails_sent":{"type":"integer","description":"The total number of emails sent for the Automation."},"id":{"type":"string","description":"A string that identifies the Automation."},"recipients":{"$ref":"#/components/schemas/AutomationWorkflowRecipients","description":"List settings for the Automation."},"report_summary":{"$ref":"#/components/schemas/AutomationWorkflowReportSummary","description":"A summary of opens and clicks for sent campaigns."},"settings":{"$ref":"#/components/schemas/AutomationWorkflowSettings","description":"The settings for the Automation workflow."},"start_time":{"type":"string","format":"date-time","description":"The date and time the Automation was started in ISO 8601 format."},"status":{"$ref":"#/components/schemas/AutomationWorkflowStatus","description":"The current status of the Automation."},"tracking":{"$ref":"#/components/schemas/AutomationWorkflowTracking","description":"The tracking options for the Automation."},"trigger_settings":{"$ref":"#/components/schemas/AutomationWorkflowTriggerSettings","description":"Available triggers for Automation workflows."}},"description":"A summary of an individual Automation workflow's settings and content.","title":"AutomationWorkflow"},"automations_list_Response_200":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/30AutomationsGetResponsesContentApplicationJsonSchemaLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"automations":{"type":"array","items":{"$ref":"#/components/schemas/AutomationWorkflow"},"description":"An array of objects, each representing an Automation workflow."},"total_items":{"type":"integer","description":"The total number of items matching the query regardless of pagination."}},"description":"An array of objects, each representing an Automation workflow.","title":"automations_list_Response_200"},"30AutomationsPostRequestBodyContentApplicationJsonSchemaRecipients":{"type":"object","properties":{"list_id":{"type":"string","description":"The id of the List."},"store_id":{"type":"string","description":"The id of the store."}},"description":"List settings for the Automation.","title":"30AutomationsPostRequestBodyContentApplicationJsonSchemaRecipients"},"30AutomationsPostRequestBodyContentApplicationJsonSchemaSettings":{"type":"object","properties":{"from_name":{"type":"string","description":"The 'from' name for the Automation (not an email address)."},"reply_to":{"type":"string","description":"The reply-to email address for the Automation."}},"description":"The settings for the Automation workflow.","title":"30AutomationsPostRequestBodyContentApplicationJsonSchemaSettings"},"30AutomationsPostRequestBodyContentApplicationJsonSchemaTriggerSettingsWorkflowType":{"type":"string","enum":["abandonedBrowse","abandonedCart","emailFollowup","singleWelcome"],"description":"The type of Automation workflow.","title":"30AutomationsPostRequestBodyContentApplicationJsonSchemaTriggerSettingsWorkflowType"},"30AutomationsPostRequestBodyContentApplicationJsonSchemaTriggerSettings":{"type":"object","properties":{"workflow_type":{"$ref":"#/components/schemas/30AutomationsPostRequestBodyContentApplicationJsonSchemaTriggerSettingsWorkflowType","description":"The type of Automation workflow."}},"required":["workflow_type"],"description":"Trigger settings for the Automation.","title":"30AutomationsPostRequestBodyContentApplicationJsonSchemaTriggerSettings"},"30AutomationsWorkflowIdEmailsGetResponsesContentApplicationJsonSchemaLinksItemsItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"30AutomationsWorkflowIdEmailsGetResponsesContentApplicationJsonSchemaLinksItemsItemsMethod"},"30AutomationsWorkflowIdEmailsGetResponsesContentApplicationJsonSchemaLinksItemsItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/30AutomationsWorkflowIdEmailsGetResponsesContentApplicationJsonSchemaLinksItemsItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"30AutomationsWorkflowIdEmailsGetResponsesContentApplicationJsonSchemaLinksItemsItems"},"AutomationWorkflowEmailLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"AutomationWorkflowEmailLinksItemsMethod"},"AutomationWorkflowEmailLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/AutomationWorkflowEmailLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"AutomationWorkflowEmailLinksItems"},"AutomationWorkflowEmailDelayAction":{"type":"string","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"],"description":"The action that triggers the delay of an Automation email.","title":"AutomationWorkflowEmailDelayAction"},"AutomationWorkflowEmailDelayDirection":{"type":"string","enum":["before","after"],"description":"Whether the delay settings describe before or after the delay action of an Automation email.","title":"AutomationWorkflowEmailDelayDirection"},"AutomationWorkflowEmailDelayType":{"type":"string","enum":["now","day","hour","week"],"description":"The type of delay for an Automation email.","title":"AutomationWorkflowEmailDelayType"},"AutomationWorkflowEmailDelay":{"type":"object","properties":{"action":{"$ref":"#/components/schemas/AutomationWorkflowEmailDelayAction","description":"The action that triggers the delay of an Automation email."},"action_description":{"type":"string","description":"The user-friendly description of the action that triggers an Automation email."},"amount":{"type":"integer","description":"The delay amount for an Automation email."},"direction":{"$ref":"#/components/schemas/AutomationWorkflowEmailDelayDirection","description":"Whether the delay settings describe before or after the delay action of an Automation email."},"full_description":{"type":"string","description":"The user-friendly description of the delay and trigger action settings for an Automation email."},"type":{"$ref":"#/components/schemas/AutomationWorkflowEmailDelayType","description":"The type of delay for an Automation email."}},"description":"The delay settings for an Automation email.","title":"AutomationWorkflowEmailDelay"},"AutomationWorkflowEmailRecipientsSegmentOptsMatch":{"type":"string","enum":["any","all"],"description":"Segment match type.","title":"AutomationWorkflowEmailRecipientsSegmentOptsMatch"},"AutomationWorkflowEmailRecipientsSegmentOptsSavedSegmentId":{"oneOf":[{"type":"integer"},{"type":"string","pattern":"^[0-9]+$"}],"description":"The id for an existing saved segment.","title":"AutomationWorkflowEmailRecipientsSegmentOptsSavedSegmentId"},"AutomationWorkflowEmailRecipientsSegmentOpts":{"type":"object","properties":{"conditions":{"$ref":"#/components/schemas/SegmentType"},"match":{"$ref":"#/components/schemas/AutomationWorkflowEmailRecipientsSegmentOptsMatch","description":"Segment match type."},"prebuilt_segment_id":{"type":"string","description":"The prebuilt segment id, if a prebuilt segment has been designated for this campaign."},"saved_segment_id":{"$ref":"#/components/schemas/AutomationWorkflowEmailRecipientsSegmentOptsSavedSegmentId","description":"The id for an existing saved segment."}},"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.","title":"AutomationWorkflowEmailRecipientsSegmentOpts"},"AutomationWorkflowEmailRecipients":{"type":"object","properties":{"list_id":{"type":"string","description":"The unique list id."},"list_is_active":{"type":"boolean","description":"The status of the list used, namely if it's deleted or disabled."},"list_name":{"type":"string","description":"The name of the list."},"recipient_count":{"type":"integer","description":"Count of the recipients on the associated list. Formatted as an integer."},"segment_opts":{"$ref":"#/components/schemas/AutomationWorkflowEmailRecipientsSegmentOpts","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."},"segment_text":{"type":"string","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."}},"description":"List settings for the campaign.","title":"AutomationWorkflowEmailRecipients"},"AutomationWorkflowEmailReportSummary":{"type":"object","properties":{"click_rate":{"type":"number","format":"double","description":"The number of unique clicks divided by the total number of successful deliveries."},"clicks":{"type":"integer","description":"The total number of clicks for an campaign."},"open_rate":{"type":"number","format":"double","description":"The number of unique opens divided by the total number of successful deliveries."},"opens":{"type":"integer","description":"The total number of opens for a campaign."},"subscriber_clicks":{"type":"integer","description":"The number of unique clicks."},"unique_opens":{"type":"integer","description":"The number of unique opens."}},"description":"For sent campaigns, a summary of opens and clicks.","title":"AutomationWorkflowEmailReportSummary"},"AutomationWorkflowEmailSettings":{"type":"object","properties":{"authenticate":{"type":"boolean","description":"Whether Mailchimp [authenticated](https://mailchimp.com/help/about-email-authentication/) the campaign. Defaults to `true`."},"auto_fb_post":{"type":"array","items":{"type":"string"},"description":"An array of [Facebook](https://mailchimp.com/help/connect-or-disconnect-the-facebook-integration/) page ids to auto-post to."},"auto_footer":{"type":"boolean","description":"Automatically append Mailchimp's [default footer](https://mailchimp.com/help/about-campaign-footers/) to the campaign."},"auto_tweet":{"type":"boolean","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."},"drag_and_drop":{"type":"boolean","description":"Whether the campaign uses the drag-and-drop editor."},"fb_comments":{"type":"boolean","description":"Allows Facebook comments on the campaign (also force-enables the Campaign Archive toolbar). Defaults to `true`."},"from_name":{"type":"string","description":"The 'from' name on the campaign (not an email address)."},"inline_css":{"type":"boolean","description":"Automatically inline the CSS included with the campaign content."},"preview_text":{"type":"string","description":"The preview text for the campaign."},"reply_to":{"type":"string","description":"The reply-to email address for the campaign."},"subject_line":{"type":"string","description":"The subject line for the campaign."},"template_id":{"type":"integer","description":"The id for the template used in this campaign."},"title":{"type":"string","description":"The title of the campaign."}},"description":"Settings for the campaign including the email subject, from name, and from email address.","title":"AutomationWorkflowEmailSettings"},"AutomationWorkflowEmailSocialCard":{"type":"object","properties":{"description":{"type":"string","description":"A short summary of the campaign to display."},"image_url":{"type":"string","description":"The url for the header image for the card."},"title":{"type":"string","description":"The title for the card. Typically the subject line of the campaign."}},"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/).","title":"AutomationWorkflowEmailSocialCard"},"AutomationWorkflowEmailStatus":{"type":"string","enum":["save","paused","sending"],"description":"The current status of the campaign.","title":"AutomationWorkflowEmailStatus"},"AutomationWorkflowEmailTrackingCapsule":{"type":"object","properties":{"notes":{"type":"boolean","description":"Update contact notes for a campaign based on a subscriber's email address."}},"description":"Deprecated","title":"AutomationWorkflowEmailTrackingCapsule"},"AutomationWorkflowEmailTrackingSalesforce":{"type":"object","properties":{"campaign":{"type":"boolean","description":"Create a campaign in a connected Salesforce account."},"notes":{"type":"boolean","description":"Update contact notes for a campaign based on a subscriber's email address."}},"description":"Deprecated","title":"AutomationWorkflowEmailTrackingSalesforce"},"AutomationWorkflowEmailTracking":{"type":"object","properties":{"capsule":{"$ref":"#/components/schemas/AutomationWorkflowEmailTrackingCapsule","description":"Deprecated"},"clicktale":{"type":"string","description":"The custom slug for [Click Tale](https://mailchimp.com/help/additional-tracking-options-for-campaigns/) tracking (max of 50 bytes)."},"ecomm360":{"type":"boolean","description":"Whether to enable e-commerce tracking."},"goal_tracking":{"type":"boolean","description":"Deprecated"},"google_analytics":{"type":"string","description":"The custom slug for [Google Analytics](https://mailchimp.com/help/integrate-google-analytics-with-mailchimp/) tracking (max of 50 bytes)."},"html_clicks":{"type":"boolean","description":"Whether to [track clicks](https://mailchimp.com/help/enable-and-view-click-tracking/) in the HTML version of the campaign. Defaults to `true`."},"opens":{"type":"boolean","description":"Whether to [track opens](https://mailchimp.com/help/about-open-tracking/). Defaults to `true`."},"salesforce":{"$ref":"#/components/schemas/AutomationWorkflowEmailTrackingSalesforce","description":"Deprecated"},"text_clicks":{"type":"boolean","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`."}},"description":"The tracking options for a campaign.","title":"AutomationWorkflowEmailTracking"},"AutomationWorkflowEmailTriggerSettingsRuntimeDaysItems":{"type":"string","enum":["sunday","monday","tuesday","wednesday","thursday","friday","saturday"],"title":"AutomationWorkflowEmailTriggerSettingsRuntimeDaysItems"},"AutomationWorkflowEmailTriggerSettingsRuntimeHoursType":{"type":"string","enum":["send_asap","send_between","send_at"],"description":"When to send the Automation email.","title":"AutomationWorkflowEmailTriggerSettingsRuntimeHoursType"},"AutomationWorkflowEmailTriggerSettingsRuntimeHours":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/AutomationWorkflowEmailTriggerSettingsRuntimeHoursType","description":"When to send the Automation email."}},"required":["type"],"description":"The hours an Automation workflow can send.","title":"AutomationWorkflowEmailTriggerSettingsRuntimeHours"},"AutomationWorkflowEmailTriggerSettingsRuntime":{"type":"object","properties":{"days":{"type":"array","items":{"$ref":"#/components/schemas/AutomationWorkflowEmailTriggerSettingsRuntimeDaysItems"},"description":"The days an Automation workflow can send."},"hours":{"$ref":"#/components/schemas/AutomationWorkflowEmailTriggerSettingsRuntimeHours","description":"The hours an Automation workflow can send."}},"description":"A workflow's runtime settings for an Automation.","title":"AutomationWorkflowEmailTriggerSettingsRuntime"},"AutomationWorkflowEmailTriggerSettingsWorkflowType":{"type":"string","enum":["abandonedBrowse","abandonedCart","api","bestCustomers","categoryFollowup","dateAdded","emailFollowup","emailSeries","groupAdd","groupRemove","mandrill","productFollowup","purchaseFollowup","recurringEvent","specialEvent","visitUrl","welcomeSeries"],"description":"The type of Automation workflow.","title":"AutomationWorkflowEmailTriggerSettingsWorkflowType"},"AutomationWorkflowEmailTriggerSettings":{"type":"object","properties":{"runtime":{"$ref":"#/components/schemas/AutomationWorkflowEmailTriggerSettingsRuntime","description":"A workflow's runtime settings for an Automation."},"workflow_emails_count":{"type":"integer","description":"The number of emails in the Automation workflow."},"workflow_title":{"type":"string","description":"The title of the workflow type."},"workflow_type":{"$ref":"#/components/schemas/AutomationWorkflowEmailTriggerSettingsWorkflowType","description":"The type of Automation workflow."}},"required":["workflow_type"],"description":"Available triggers for Automation workflows.","title":"AutomationWorkflowEmailTriggerSettings"},"AutomationWorkflowEmail":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/AutomationWorkflowEmailLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"archive_url":{"type":"string","description":"The link to the campaign's archive version in ISO 8601 format."},"content_type":{"type":"string","description":"How the campaign's content is put together ('template', 'drag_and_drop', 'html', 'url')."},"create_time":{"type":"string","format":"date-time","description":"The date and time the campaign was created in ISO 8601 format."},"delay":{"$ref":"#/components/schemas/AutomationWorkflowEmailDelay","description":"The delay settings for an Automation email."},"emails_sent":{"type":"integer","description":"The total number of emails sent for this campaign."},"has_logo_merge_tag":{"type":"boolean","description":"Determines if the campaign contains the *|BRAND:LOGO|* merge tag."},"id":{"type":"string","description":"A string that uniquely identifies the Automation email."},"needs_block_refresh":{"type":"boolean","description":"Determines if the automation email needs its blocks refreshed by opening the web-based campaign editor."},"position":{"type":"integer","description":"The position of an Automation email in a workflow."},"recipients":{"$ref":"#/components/schemas/AutomationWorkflowEmailRecipients","description":"List settings for the campaign."},"report_summary":{"$ref":"#/components/schemas/AutomationWorkflowEmailReportSummary","description":"For sent campaigns, a summary of opens and clicks."},"send_time":{"type":"string","format":"date-time","description":" The date and time a campaign was sent in ISO 8601 format"},"settings":{"$ref":"#/components/schemas/AutomationWorkflowEmailSettings","description":"Settings for the campaign including the email subject, from name, and from email address."},"social_card":{"$ref":"#/components/schemas/AutomationWorkflowEmailSocialCard","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/)."},"start_time":{"type":"string","format":"date-time","description":"The date and time the campaign was started in ISO 8601 format."},"status":{"$ref":"#/components/schemas/AutomationWorkflowEmailStatus","description":"The current status of the campaign."},"tracking":{"$ref":"#/components/schemas/AutomationWorkflowEmailTracking","description":"The tracking options for a campaign."},"trigger_settings":{"$ref":"#/components/schemas/AutomationWorkflowEmailTriggerSettings","description":"Available triggers for Automation workflows."},"web_id":{"type":"integer","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}`."},"workflow_id":{"type":"string","description":"A string that uniquely identifies an Automation workflow."}},"description":"A summary of an individual Automation workflow email.","title":"AutomationWorkflowEmail"},"automations_list-emails_Response_200":{"type":"object","properties":{"_links":{"type":"array","items":{"type":"array","items":{"$ref":"#/components/schemas/30AutomationsWorkflowIdEmailsGetResponsesContentApplicationJsonSchemaLinksItemsItems"}},"description":"A list of link types and descriptions for the API schema documents."},"emails":{"type":"array","items":{"$ref":"#/components/schemas/AutomationWorkflowEmail"},"description":"An array of objects, each representing an email in an Automation workflow."},"total_items":{"type":"integer","description":"The total number of items matching the query regardless of pagination."}},"description":"A summary of the emails in an Automation workflow.","title":"automations_list-emails_Response_200"},"30AutomationsWorkflowIdEmailsWorkflowEmailIdPatchRequestBodyContentApplicationJsonSchemaDelayAction":{"type":"string","enum":["signup","ecomm_abandoned_browse","ecomm_abandoned_cart"],"description":"The action that triggers the delay of an automation emails.","title":"30AutomationsWorkflowIdEmailsWorkflowEmailIdPatchRequestBodyContentApplicationJsonSchemaDelayAction"},"30AutomationsWorkflowIdEmailsWorkflowEmailIdPatchRequestBodyContentApplicationJsonSchemaDelayDirection":{"type":"string","enum":["after"],"description":"Whether the delay settings describe before or after the delay action of an automation email.","title":"30AutomationsWorkflowIdEmailsWorkflowEmailIdPatchRequestBodyContentApplicationJsonSchemaDelayDirection"},"30AutomationsWorkflowIdEmailsWorkflowEmailIdPatchRequestBodyContentApplicationJsonSchemaDelayType":{"type":"string","enum":["now","day","hour","week"],"description":"The type of delay for an automation email.","title":"30AutomationsWorkflowIdEmailsWorkflowEmailIdPatchRequestBodyContentApplicationJsonSchemaDelayType"},"30AutomationsWorkflowIdEmailsWorkflowEmailIdPatchRequestBodyContentApplicationJsonSchemaDelay":{"type":"object","properties":{"action":{"$ref":"#/components/schemas/30AutomationsWorkflowIdEmailsWorkflowEmailIdPatchRequestBodyContentApplicationJsonSchemaDelayAction","description":"The action that triggers the delay of an automation emails."},"amount":{"type":"integer","description":"The delay amount for an automation email."},"direction":{"$ref":"#/components/schemas/30AutomationsWorkflowIdEmailsWorkflowEmailIdPatchRequestBodyContentApplicationJsonSchemaDelayDirection","description":"Whether the delay settings describe before or after the delay action of an automation email."},"type":{"$ref":"#/components/schemas/30AutomationsWorkflowIdEmailsWorkflowEmailIdPatchRequestBodyContentApplicationJsonSchemaDelayType","description":"The type of delay for an automation email."}},"required":["action"],"description":"The delay settings for an automation email.","title":"30AutomationsWorkflowIdEmailsWorkflowEmailIdPatchRequestBodyContentApplicationJsonSchemaDelay"},"30AutomationsWorkflowIdEmailsWorkflowEmailIdPatchRequestBodyContentApplicationJsonSchemaSettings":{"type":"object","properties":{"from_name":{"type":"string","description":"The 'from' name for the Automation (not an email address)."},"preview_text":{"type":"string","description":"The preview text for the campaign."},"reply_to":{"type":"string","description":"The reply-to email address for the Automation."},"subject_line":{"type":"string","description":"The subject line for the campaign."},"title":{"type":"string","description":"The title of the Automation."}},"description":"Settings for the campaign including the email subject, from name, and from email address.","title":"30AutomationsWorkflowIdEmailsWorkflowEmailIdPatchRequestBodyContentApplicationJsonSchemaSettings"},"30AutomationsWorkflowIdEmailsWorkflowEmailIdQueueGetResponsesContentApplicationJsonSchemaLinksItemsItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"30AutomationsWorkflowIdEmailsWorkflowEmailIdQueueGetResponsesContentApplicationJsonSchemaLinksItemsItemsMethod"},"30AutomationsWorkflowIdEmailsWorkflowEmailIdQueueGetResponsesContentApplicationJsonSchemaLinksItemsItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/30AutomationsWorkflowIdEmailsWorkflowEmailIdQueueGetResponsesContentApplicationJsonSchemaLinksItemsItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"30AutomationsWorkflowIdEmailsWorkflowEmailIdQueueGetResponsesContentApplicationJsonSchemaLinksItemsItems"},"30AutomationsWorkflowIdEmailsWorkflowEmailIdQueueGetResponsesContentApplicationJsonSchemaQueueItemsLinksItemsItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"30AutomationsWorkflowIdEmailsWorkflowEmailIdQueueGetResponsesContentApplicationJsonSchemaQueueItemsLinksItemsItemsMethod"},"30AutomationsWorkflowIdEmailsWorkflowEmailIdQueueGetResponsesContentApplicationJsonSchemaQueueItemsLinksItemsItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/30AutomationsWorkflowIdEmailsWorkflowEmailIdQueueGetResponsesContentApplicationJsonSchemaQueueItemsLinksItemsItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"30AutomationsWorkflowIdEmailsWorkflowEmailIdQueueGetResponsesContentApplicationJsonSchemaQueueItemsLinksItemsItems"},"30AutomationsWorkflowIdEmailsWorkflowEmailIdQueueGetResponsesContentApplicationJsonSchemaQueueItems":{"type":"object","properties":{"_links":{"type":"array","items":{"type":"array","items":{"$ref":"#/components/schemas/30AutomationsWorkflowIdEmailsWorkflowEmailIdQueueGetResponsesContentApplicationJsonSchemaQueueItemsLinksItemsItems"}},"description":"A list of link types and descriptions for the API schema documents."},"email_address":{"type":"string","description":"The list member's email address."},"email_id":{"type":"string","description":"A string that uniquely identifies an email in an Automation workflow."},"id":{"type":"string","description":"The MD5 hash of the lowercase version of the list member's email address."},"list_id":{"type":"string","description":"A string that uniquely identifies a list."},"next_send":{"type":"string","format":"date-time","description":"The date and time of the next send for the workflow email in ISO 8601 format."},"workflow_id":{"type":"string","description":"A string that uniquely identifies an Automation workflow."}},"required":["email_address"],"description":"Information about subscribers in an Automation email queue.","title":"30AutomationsWorkflowIdEmailsWorkflowEmailIdQueueGetResponsesContentApplicationJsonSchemaQueueItems"},"automations_list-email-queue_Response_200":{"type":"object","properties":{"_links":{"type":"array","items":{"type":"array","items":{"$ref":"#/components/schemas/30AutomationsWorkflowIdEmailsWorkflowEmailIdQueueGetResponsesContentApplicationJsonSchemaLinksItemsItems"}},"description":"A list of link types and descriptions for the API schema documents."},"email_id":{"type":"string","description":"A string that uniquely identifies an email in an Automation workflow."},"queue":{"type":"array","items":{"$ref":"#/components/schemas/30AutomationsWorkflowIdEmailsWorkflowEmailIdQueueGetResponsesContentApplicationJsonSchemaQueueItems"},"description":"An array of objects, each representing a subscriber queue for an email in an Automation workflow."},"total_items":{"type":"integer","description":"The total number of items matching the query regardless of pagination."},"workflow_id":{"type":"string","description":"A string that uniquely identifies an Automation workflow."}},"description":"An automation workflow","title":"automations_list-email-queue_Response_200"},"SubscriberInAutomationQueueLinksItemsItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"SubscriberInAutomationQueueLinksItemsItemsMethod"},"SubscriberInAutomationQueueLinksItemsItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/SubscriberInAutomationQueueLinksItemsItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"SubscriberInAutomationQueueLinksItemsItems"},"SubscriberInAutomationQueue":{"type":"object","properties":{"_links":{"type":"array","items":{"type":"array","items":{"$ref":"#/components/schemas/SubscriberInAutomationQueueLinksItemsItems"}},"description":"A list of link types and descriptions for the API schema documents."},"email_address":{"type":"string","description":"The list member's email address."},"email_id":{"type":"string","description":"A string that uniquely identifies an email in an Automation workflow."},"id":{"type":"string","description":"The MD5 hash of the lowercase version of the list member's email address."},"list_id":{"type":"string","description":"A string that uniquely identifies a list."},"list_is_active":{"type":"boolean","description":"The status of the list used, namely if it's deleted or disabled."},"next_send":{"type":"string","format":"date-time","description":"The date and time of the next send for the workflow email in ISO 8601 format."},"workflow_id":{"type":"string","description":"A string that uniquely identifies an Automation workflow."}},"description":"Information about subscribers in an Automation email queue.","title":"SubscriberInAutomationQueue"},"30AutomationsWorkflowIdRemovedSubscribersGetResponsesContentApplicationJsonSchemaLinksItemsItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"30AutomationsWorkflowIdRemovedSubscribersGetResponsesContentApplicationJsonSchemaLinksItemsItemsMethod"},"30AutomationsWorkflowIdRemovedSubscribersGetResponsesContentApplicationJsonSchemaLinksItemsItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/30AutomationsWorkflowIdRemovedSubscribersGetResponsesContentApplicationJsonSchemaLinksItemsItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"30AutomationsWorkflowIdRemovedSubscribersGetResponsesContentApplicationJsonSchemaLinksItemsItems"},"SubscriberRemovedFromAutomationWorkflowLinksItemsItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"SubscriberRemovedFromAutomationWorkflowLinksItemsItemsMethod"},"SubscriberRemovedFromAutomationWorkflowLinksItemsItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/SubscriberRemovedFromAutomationWorkflowLinksItemsItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"SubscriberRemovedFromAutomationWorkflowLinksItemsItems"},"SubscriberRemovedFromAutomationWorkflow":{"type":"object","properties":{"_links":{"type":"array","items":{"type":"array","items":{"$ref":"#/components/schemas/SubscriberRemovedFromAutomationWorkflowLinksItemsItems"}},"description":"A list of link types and descriptions for the API schema documents."},"email_address":{"type":"string","description":"The list member's email address."},"id":{"type":"string","description":"The MD5 hash of the lowercase version of the list member's email address."},"list_id":{"type":"string","description":"A string that uniquely identifies a list."},"workflow_id":{"type":"string","description":"A string that uniquely identifies an Automation workflow."}},"description":"A summary of a subscriber removed from an Automation workflow.","title":"SubscriberRemovedFromAutomationWorkflow"},"automations_list-removed-subscribers_Response_200":{"type":"object","properties":{"_links":{"type":"array","items":{"type":"array","items":{"$ref":"#/components/schemas/30AutomationsWorkflowIdRemovedSubscribersGetResponsesContentApplicationJsonSchemaLinksItemsItems"}},"description":"A list of link types and descriptions for the API schema documents."},"subscribers":{"type":"array","items":{"$ref":"#/components/schemas/SubscriberRemovedFromAutomationWorkflow"},"description":"An array of objects, each representing a subscriber who was removed from an Automation workflow."},"total_items":{"type":"integer","description":"The total number of items matching the query regardless of pagination."},"workflow_id":{"type":"string","description":"A string that uniquely identifies an Automation workflow."}},"description":"A summary of the subscribers who were removed from an Automation workflow.","title":"automations_list-removed-subscribers_Response_200"},"30BatchWebhooksGetResponsesContentApplicationJsonSchemaLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"30BatchWebhooksGetResponsesContentApplicationJsonSchemaLinksItemsMethod"},"30BatchWebhooksGetResponsesContentApplicationJsonSchemaLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/30BatchWebhooksGetResponsesContentApplicationJsonSchemaLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"30BatchWebhooksGetResponsesContentApplicationJsonSchemaLinksItems"},"BatchWebhookLinksItemsItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"BatchWebhookLinksItemsItemsMethod"},"BatchWebhookLinksItemsItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/BatchWebhookLinksItemsItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"BatchWebhookLinksItemsItems"},"BatchWebhook":{"type":"object","properties":{"_links":{"type":"array","items":{"type":"array","items":{"$ref":"#/components/schemas/BatchWebhookLinksItemsItems"}},"description":"A list of link types and descriptions for the API schema documents."},"enabled":{"type":"boolean","description":"Whether the webhook receives requests or not."},"id":{"type":"string","description":"A string that uniquely identifies this Batch Webhook."},"signing_enabled":{"type":"boolean","description":"Whether outbound deliveries are HMAC-signed."},"url":{"type":"string","description":"A valid URL for the Webhook."}},"description":"A webhook configured for batch status updates.","title":"BatchWebhook"},"batch-webhooks_list_Response_200":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/30BatchWebhooksGetResponsesContentApplicationJsonSchemaLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"total_items":{"type":"integer","description":"The total number of items matching the query regardless of pagination."},"webhooks":{"type":"array","items":{"$ref":"#/components/schemas/BatchWebhook"},"description":"An array of objects, each representing a Batch Webhook."}},"description":"Manage webhooks for batch requests.","title":"batch-webhooks_list_Response_200"},"30BatchWebhooksPostResponsesContentApplicationJsonSchemaLinksItemsItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"30BatchWebhooksPostResponsesContentApplicationJsonSchemaLinksItemsItemsMethod"},"30BatchWebhooksPostResponsesContentApplicationJsonSchemaLinksItemsItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/30BatchWebhooksPostResponsesContentApplicationJsonSchemaLinksItemsItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"30BatchWebhooksPostResponsesContentApplicationJsonSchemaLinksItemsItems"},"batch-webhooks_create_Response_200":{"type":"object","properties":{"_links":{"type":"array","items":{"type":"array","items":{"$ref":"#/components/schemas/30BatchWebhooksPostResponsesContentApplicationJsonSchemaLinksItemsItems"}},"description":"A list of link types and descriptions for the API schema documents."},"enabled":{"type":"boolean","description":"Whether the webhook receives requests or not."},"id":{"type":"string","description":"A string that uniquely identifies this Batch Webhook."},"signing_enabled":{"type":"boolean","description":"Whether outbound deliveries are HMAC-signed."},"url":{"type":"string","description":"A valid URL for the Webhook."},"signing_secret":{"type":"string","description":"The HMAC signing secret. Returned exactly once at creation. This should be stored securely; if lost, delete and recreate the webhook to obtain a new secret."}},"description":"A webhook configured for batch status updates.","title":"batch-webhooks_create_Response_200"},"30BatchesGetResponsesContentApplicationJsonSchemaLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"30BatchesGetResponsesContentApplicationJsonSchemaLinksItemsMethod"},"30BatchesGetResponsesContentApplicationJsonSchemaLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/30BatchesGetResponsesContentApplicationJsonSchemaLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"30BatchesGetResponsesContentApplicationJsonSchemaLinksItems"},"BatchLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"BatchLinksItemsMethod"},"BatchLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/BatchLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"BatchLinksItems"},"BatchCompletedAt":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","enum":[""]}],"description":"The date and time when all operations in the batch request completed in ISO 8601 format.","title":"BatchCompletedAt"},"BatchStatus":{"type":"string","enum":["pending","preprocessing","started","finalizing","finished"],"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.","title":"BatchStatus"},"Batch":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/BatchLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"completed_at":{"$ref":"#/components/schemas/BatchCompletedAt","description":"The date and time when all operations in the batch request completed in ISO 8601 format."},"errored_operations":{"type":"integer","description":"The number of completed operations that returned an error."},"finished_operations":{"type":"integer","description":"The number of completed operations. This includes operations that returned an error."},"id":{"type":"string","description":"A string that uniquely identifies this batch request."},"response_body_url":{"type":"string","description":"The URL of the gzipped archive of the results of all the operations."},"status":{"$ref":"#/components/schemas/BatchStatus","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."},"submitted_at":{"type":"string","format":"date-time","description":"The date and time when the server received the batch request in ISO 8601 format."},"total_operations":{"type":"integer","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."}},"description":"The status of a batch request","title":"Batch"},"batches_list_Response_200":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/30BatchesGetResponsesContentApplicationJsonSchemaLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"batches":{"type":"array","items":{"$ref":"#/components/schemas/Batch"},"description":"An array of objects representing batch calls."},"total_items":{"type":"integer","description":"The total number of items matching the query regardless of pagination."}},"description":"A summary of batch requests that have been made.","title":"batches_list_Response_200"},"30BatchesPostRequestBodyContentApplicationJsonSchemaOperationsItemsHeaders":{"type":"object","properties":{},"description":"Any HTTP headers to include with the request.","title":"30BatchesPostRequestBodyContentApplicationJsonSchemaOperationsItemsHeaders"},"30BatchesPostRequestBodyContentApplicationJsonSchemaOperationsItemsMethod":{"type":"string","enum":["GET","get","POST","post","PUT","put","PATCH","patch","DELETE","delete"],"description":"The HTTP method to use for the operation.","title":"30BatchesPostRequestBodyContentApplicationJsonSchemaOperationsItemsMethod"},"30BatchesPostRequestBodyContentApplicationJsonSchemaOperationsItemsParams":{"type":"object","properties":{},"description":"Any request query parameters. Example parameters: {\"count\":10, \"offset\":0}","title":"30BatchesPostRequestBodyContentApplicationJsonSchemaOperationsItemsParams"},"30BatchesPostRequestBodyContentApplicationJsonSchemaOperationsItems":{"type":"object","properties":{"body":{"type":"string","description":"A string containing the JSON body to use with the request."},"headers":{"$ref":"#/components/schemas/30BatchesPostRequestBodyContentApplicationJsonSchemaOperationsItemsHeaders","description":"Any HTTP headers to include with the request."},"method":{"$ref":"#/components/schemas/30BatchesPostRequestBodyContentApplicationJsonSchemaOperationsItemsMethod","description":"The HTTP method to use for the operation."},"operation_id":{"type":"string","description":"An optional client-supplied id returned with the operation results."},"params":{"$ref":"#/components/schemas/30BatchesPostRequestBodyContentApplicationJsonSchemaOperationsItemsParams","description":"Any request query parameters. Example parameters: {\"count\":10, \"offset\":0}"},"path":{"type":"string","description":"The relative path to use for the operation."}},"required":["method","path"],"title":"30BatchesPostRequestBodyContentApplicationJsonSchemaOperationsItems"},"CampaignFoldersLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"CampaignFoldersLinksItemsMethod"},"CampaignFoldersLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/CampaignFoldersLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"CampaignFoldersLinksItems"},"CampaignFoldersFoldersItemsLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"CampaignFoldersFoldersItemsLinksItemsMethod"},"CampaignFoldersFoldersItemsLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/CampaignFoldersFoldersItemsLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"CampaignFoldersFoldersItemsLinksItems"},"CampaignFoldersFoldersItems":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/CampaignFoldersFoldersItemsLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"count":{"type":"integer","description":"The number of campaigns in the folder."},"id":{"type":"string","description":"A string that uniquely identifies this campaign folder."},"name":{"type":"string","description":"The name of the folder."}},"description":"A folder used to organize campaigns.","title":"CampaignFoldersFoldersItems"},"CampaignFolders":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/CampaignFoldersLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"folders":{"type":"array","items":{"$ref":"#/components/schemas/CampaignFoldersFoldersItems"},"description":"An array of objects representing campaign folders."},"total_items":{"type":"integer","description":"The total number of items matching the query regardless of pagination."}},"description":"A list of campaign folders","title":"CampaignFolders"},"30CampaignFoldersFolderIdGetResponsesContentApplicationJsonSchemaLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"30CampaignFoldersFolderIdGetResponsesContentApplicationJsonSchemaLinksItemsMethod"},"30CampaignFoldersFolderIdGetResponsesContentApplicationJsonSchemaLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/30CampaignFoldersFolderIdGetResponsesContentApplicationJsonSchemaLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"30CampaignFoldersFolderIdGetResponsesContentApplicationJsonSchemaLinksItems"},"campaign-folders_get_Response_200":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/30CampaignFoldersFolderIdGetResponsesContentApplicationJsonSchemaLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"count":{"type":"integer","description":"The number of campaigns in the folder."},"id":{"type":"string","description":"A string that uniquely identifies this campaign folder."},"name":{"type":"string","description":"The name of the folder."}},"description":"A folder used to organize campaigns.","title":"campaign-folders_get_Response_200"},"30CampaignFoldersFolderIdPatchResponsesContentApplicationJsonSchemaLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"30CampaignFoldersFolderIdPatchResponsesContentApplicationJsonSchemaLinksItemsMethod"},"30CampaignFoldersFolderIdPatchResponsesContentApplicationJsonSchemaLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/30CampaignFoldersFolderIdPatchResponsesContentApplicationJsonSchemaLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"30CampaignFoldersFolderIdPatchResponsesContentApplicationJsonSchemaLinksItems"},"campaign-folders_update_Response_200":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/30CampaignFoldersFolderIdPatchResponsesContentApplicationJsonSchemaLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"count":{"type":"integer","description":"The number of campaigns in the folder."},"id":{"type":"string","description":"A string that uniquely identifies this campaign folder."},"name":{"type":"string","description":"The name of the folder."}},"description":"A folder used to organize campaigns.","title":"campaign-folders_update_Response_200"},"30CampaignsGetParametersType":{"type":"string","enum":["regular","plaintext","absplit","rss","variate"],"title":"30CampaignsGetParametersType"},"30CampaignsGetParametersStatus":{"type":"string","enum":["save","paused","schedule","sending","sent"],"title":"30CampaignsGetParametersStatus"},"30CampaignsGetParametersSortField":{"type":"string","enum":["create_time","send_time"],"title":"30CampaignsGetParametersSortField"},"30CampaignsGetParametersSortDir":{"type":"string","enum":["ASC","DESC"],"title":"30CampaignsGetParametersSortDir"},"30CampaignsGetResponsesContentApplicationJsonSchemaLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"30CampaignsGetResponsesContentApplicationJsonSchemaLinksItemsMethod"},"30CampaignsGetResponsesContentApplicationJsonSchemaLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/30CampaignsGetResponsesContentApplicationJsonSchemaLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"30CampaignsGetResponsesContentApplicationJsonSchemaLinksItems"},"CampaignsLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"CampaignsLinksItemsMethod"},"CampaignsLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/CampaignsLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"CampaignsLinksItems"},"AbTestingOptionsPickWinner":{"type":"string","enum":["opens","clicks","manual"],"description":"How we should evaluate a winner. Based on 'opens', 'clicks', or 'manual'.","title":"AbTestingOptionsPickWinner"},"AbTestingOptionsSplitTest":{"type":"string","enum":["subject","from_name","schedule"],"description":"The type of AB split to run.","title":"AbTestingOptionsSplitTest"},"AbTestingOptionsWaitUnits":{"type":"string","enum":["hours","days"],"description":"How unit of time for measuring the winner ('hours' or 'days'). This cannot be changed after a campaign is sent.","title":"AbTestingOptionsWaitUnits"},"ABTestingOptions":{"type":"object","properties":{"from_name_a":{"type":"string","description":"For campaigns split on 'From Name', the name for Group A."},"from_name_b":{"type":"string","description":"For campaigns split on 'From Name', the name for Group B."},"pick_winner":{"$ref":"#/components/schemas/AbTestingOptionsPickWinner","description":"How we should evaluate a winner. Based on 'opens', 'clicks', or 'manual'."},"reply_email_a":{"type":"string","description":"For campaigns split on 'From Name', the reply-to address for Group A."},"reply_email_b":{"type":"string","description":"For campaigns split on 'From Name', the reply-to address for Group B."},"send_time_a":{"type":"string","format":"date-time","description":"The send time for Group A."},"send_time_b":{"type":"string","format":"date-time","description":"The send time for Group B."},"send_time_winner":{"type":"string","description":"The send time for the winning version."},"split_size":{"type":"integer","minimum":1,"maximum":50,"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."},"split_test":{"$ref":"#/components/schemas/AbTestingOptionsSplitTest","description":"The type of AB split to run."},"subject_a":{"type":"string","description":"For campaigns split on 'Subject Line', the subject line for Group A."},"subject_b":{"type":"string","description":"For campaigns split on 'Subject Line', the subject line for Group B."},"wait_time":{"type":"integer","description":"The amount of time to wait before picking a winner. This cannot be changed after a campaign is sent."},"wait_units":{"$ref":"#/components/schemas/AbTestingOptionsWaitUnits","description":"How unit of time for measuring the winner ('hours' or 'days'). This cannot be changed after a campaign is sent."}},"description":"[A/B Testing](https://mailchimp.com/help/about-ab-tests/) options for a campaign.","title":"ABTestingOptions"},"CampaignsContentType":{"type":"string","enum":["template","html","url","multichannel"],"description":"How the campaign's content is put together.","title":"CampaignsContentType"},"CampaignsDeliveryStatusStatus":{"type":"string","enum":["delivering","delivered","canceling","canceled"],"description":"The current state of a campaign delivery.","title":"CampaignsDeliveryStatusStatus"},"CampaignsDeliveryStatus":{"type":"object","properties":{"can_cancel":{"type":"boolean","description":"Whether a campaign send can be canceled."},"emails_canceled":{"type":"integer","description":"The total number of emails canceled for this campaign."},"emails_sent":{"type":"integer","description":"The total number of emails confirmed sent for this campaign so far."},"enabled":{"type":"boolean","description":"Whether Campaign Delivery Status is enabled for this account and campaign."},"status":{"$ref":"#/components/schemas/CampaignsDeliveryStatusStatus","description":"The current state of a campaign delivery."}},"description":"Updates on campaigns in the process of sending.","title":"CampaignsDeliveryStatus"},"CampaignsRecipientsSegmentOptsMatch":{"type":"string","enum":["any","all"],"description":"Segment match type.","title":"CampaignsRecipientsSegmentOptsMatch"},"CampaignsRecipientsSegmentOptsSavedSegmentId":{"oneOf":[{"type":"integer"},{"type":"string","pattern":"^[0-9]+$"}],"description":"The id for an existing saved segment.","title":"CampaignsRecipientsSegmentOptsSavedSegmentId"},"CampaignsRecipientsSegmentOpts":{"type":"object","properties":{"conditions":{"$ref":"#/components/schemas/SegmentType"},"match":{"$ref":"#/components/schemas/CampaignsRecipientsSegmentOptsMatch","description":"Segment match type."},"prebuilt_segment_id":{"type":"string","description":"The prebuilt segment id, if a prebuilt segment has been designated for this campaign."},"saved_segment_id":{"$ref":"#/components/schemas/CampaignsRecipientsSegmentOptsSavedSegmentId","description":"The id for an existing saved segment."}},"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.","title":"CampaignsRecipientsSegmentOpts"},"CampaignsRecipients":{"type":"object","properties":{"list_id":{"type":"string","description":"The unique list id."},"list_is_active":{"type":"boolean","description":"The status of the list used, namely if it's deleted or disabled."},"list_name":{"type":"string","description":"The name of the list."},"recipient_count":{"type":"integer","description":"Count of the recipients on the associated list. Formatted as an integer."},"segment_opts":{"$ref":"#/components/schemas/CampaignsRecipientsSegmentOpts","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."},"segment_text":{"type":"string","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."}},"description":"List settings for the campaign.","title":"CampaignsRecipients"},"CampaignsReportSummaryEcommerce":{"type":"object","properties":{"total_orders":{"type":"integer","description":"The total orders for a campaign."},"total_revenue":{"type":"number","format":"double","description":"The total revenue for a campaign. Calculated as the sum of all order totals minus shipping and tax totals."},"total_spent":{"type":"number","format":"double","description":"The total spent for a campaign. Calculated as the sum of all order totals with no deductions."}},"description":"E-Commerce stats for a campaign.","title":"CampaignsReportSummaryEcommerce"},"CampaignsReportSummary":{"type":"object","properties":{"click_rate":{"type":"number","format":"double","description":"The number of unique clicks divided by the total number of successful deliveries."},"clicks":{"type":"integer","description":"The total number of clicks for an campaign."},"ecommerce":{"$ref":"#/components/schemas/CampaignsReportSummaryEcommerce","description":"E-Commerce stats for a campaign."},"open_rate":{"type":"number","format":"double","description":"The number of unique opens divided by the total number of successful deliveries."},"opens":{"type":"integer","description":"The total number of opens for a campaign."},"subscriber_clicks":{"type":"integer","description":"The number of unique clicks."},"unique_opens":{"type":"integer","description":"The number of unique opens."}},"description":"For sent campaigns, a summary of opens, clicks, and e-commerce data.","title":"CampaignsReportSummary"},"CampaignsResendShortcutEligibilityToNewSubscribers":{"type":"object","properties":{"is_eligible":{"type":"boolean","description":"Determines if the campaign qualifies to be resent to this segment."},"reason":{"type":"string","description":"The reason the campaign is not eligible to be resent to this segment."}},"description":"Determines if the campaign qualifies to be resent to new subscribers.","title":"CampaignsResendShortcutEligibilityToNewSubscribers"},"CampaignsResendShortcutEligibilityToNonClickers":{"type":"object","properties":{"is_eligible":{"type":"boolean","description":"Determines if the campaign qualifies to be resent to this segment."},"reason":{"type":"string","description":"The reason the campaign is not eligible to be resent to this segment."}},"description":"Determines if the campaign qualifies to be resent to non-clickers.","title":"CampaignsResendShortcutEligibilityToNonClickers"},"CampaignsResendShortcutEligibilityToNonOpeners":{"type":"object","properties":{"is_eligible":{"type":"boolean","description":"Determines if the campaign qualifies to be resent to this segment."},"reason":{"type":"string","description":"The reason the campaign is not eligible to be resent to this segment."}},"description":"Determines if the campaign qualifies to be resent to non-openers.","title":"CampaignsResendShortcutEligibilityToNonOpeners"},"CampaignsResendShortcutEligibilityToNonPurchasers":{"type":"object","properties":{"is_eligible":{"type":"boolean","description":"Determines if the campaign qualifies to be resent to this segment."},"reason":{"type":"string","description":"The reason the campaign is not eligible to be resent to this segment."}},"description":"Determines if the campaign qualifies to be resent to non-purchasers.","title":"CampaignsResendShortcutEligibilityToNonPurchasers"},"CampaignsResendShortcutEligibility":{"type":"object","properties":{"to_new_subscribers":{"$ref":"#/components/schemas/CampaignsResendShortcutEligibilityToNewSubscribers","description":"Determines if the campaign qualifies to be resent to new subscribers."},"to_non_clickers":{"$ref":"#/components/schemas/CampaignsResendShortcutEligibilityToNonClickers","description":"Determines if the campaign qualifies to be resent to non-clickers."},"to_non_openers":{"$ref":"#/components/schemas/CampaignsResendShortcutEligibilityToNonOpeners","description":"Determines if the campaign qualifies to be resent to non-openers."},"to_non_purchasers":{"$ref":"#/components/schemas/CampaignsResendShortcutEligibilityToNonPurchasers","description":"Determines if the campaign qualifies to be resent to non-purchasers."}},"description":"Determines if the campaign qualifies for the Campaign Resend Shortcuts. Only included when query parameter `include_resend_shortcuts` is `true`.","title":"CampaignsResendShortcutEligibility"},"CampaignsResendShortcutUsageOriginalCampaignShortcutType":{"type":"string","enum":["non_openers","new_subscribers","non_clickers","non_purchasers"],"description":"Which campaign resend shortcut was used.","title":"CampaignsResendShortcutUsageOriginalCampaignShortcutType"},"CampaignsResendShortcutUsageOriginalCampaign":{"type":"object","properties":{"id":{"type":"string","description":"ID for the resent campaign."},"shortcut_type":{"$ref":"#/components/schemas/CampaignsResendShortcutUsageOriginalCampaignShortcutType","description":"Which campaign resend shortcut was used."},"title":{"type":"string","description":"The title of the original campaign."},"web_id":{"type":"integer","description":"The ID for the resent campaign used in the Mailchimp web application. View this campaign in your Mailchimp account at `https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}`."}},"description":"The original campaign that was resent.","title":"CampaignsResendShortcutUsageOriginalCampaign"},"CampaignsResendShortcutUsageShortcutCampaignsItemsShortcutType":{"type":"string","enum":["non_openers","new_subscribers","non_clickers","non_purchasers"],"description":"Which campaign resend shortcut was used.","title":"CampaignsResendShortcutUsageShortcutCampaignsItemsShortcutType"},"CampaignsResendShortcutUsageShortcutCampaignsItemsStatus":{"type":"string","enum":["save","paused","schedule","sending","sent","canceled","canceling","archived"],"description":"The current status of the campaign.","title":"CampaignsResendShortcutUsageShortcutCampaignsItemsStatus"},"CampaignsResendShortcutUsageShortcutCampaignsItems":{"type":"object","properties":{"id":{"type":"string","description":"Unique ID for the resent campaign."},"send_time":{"type":"string","format":"date-time","description":"The date and time a resent campaign was sent."},"shortcut_type":{"$ref":"#/components/schemas/CampaignsResendShortcutUsageShortcutCampaignsItemsShortcutType","description":"Which campaign resend shortcut was used."},"status":{"$ref":"#/components/schemas/CampaignsResendShortcutUsageShortcutCampaignsItemsStatus","description":"The current status of the campaign."},"web_id":{"type":"integer","description":"The ID for the resent campaign used in the Mailchimp web application. View this campaign in your Mailchimp account at `https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}`."}},"title":"CampaignsResendShortcutUsageShortcutCampaignsItems"},"CampaignsResendShortcutUsage":{"type":"object","properties":{"original_campaign":{"$ref":"#/components/schemas/CampaignsResendShortcutUsageOriginalCampaign","description":"The original campaign that was resent."},"shortcut_campaigns":{"type":"array","items":{"$ref":"#/components/schemas/CampaignsResendShortcutUsageShortcutCampaignsItems"},"description":"Campaigns that were created from Campaign Resend Shortcuts for this campaign"}},"description":"Information about campaigns related through shortcuts.","title":"CampaignsResendShortcutUsage"},"CampaignsRssOptsFrequency":{"type":"string","enum":["daily","weekly","monthly"],"description":"The frequency of the RSS Campaign.","title":"CampaignsRssOptsFrequency"},"CampaignsRssOptsScheduleDailySend":{"type":"object","properties":{"friday":{"type":"boolean","description":"Sends the daily RSS Campaign on Fridays."},"monday":{"type":"boolean","description":"Sends the daily RSS Campaign on Mondays."},"saturday":{"type":"boolean","description":"Sends the daily RSS Campaign on Saturdays."},"sunday":{"type":"boolean","description":"Sends the daily RSS Campaign on Sundays."},"thursday":{"type":"boolean","description":"Sends the daily RSS Campaign on Thursdays."},"tuesday":{"type":"boolean","description":"Sends the daily RSS Campaign on Tuesdays."},"wednesday":{"type":"boolean","description":"Sends the daily RSS Campaign on Wednesdays."}},"description":"The days of the week to send a daily RSS Campaign.","title":"CampaignsRssOptsScheduleDailySend"},"CampaignsRssOptsScheduleWeeklySendDay":{"type":"string","enum":["sunday","monday","tuesday","wednesday","thursday","friday","saturday"],"description":"The day of the week to send a weekly RSS Campaign.","title":"CampaignsRssOptsScheduleWeeklySendDay"},"CampaignsRssOptsSchedule":{"type":"object","properties":{"daily_send":{"$ref":"#/components/schemas/CampaignsRssOptsScheduleDailySend","description":"The days of the week to send a daily RSS Campaign."},"hour":{"type":"integer","minimum":0,"maximum":23,"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/)."},"monthly_send_date":{"type":"number","format":"double","minimum":0,"maximum":31,"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."},"weekly_send_day":{"$ref":"#/components/schemas/CampaignsRssOptsScheduleWeeklySendDay","description":"The day of the week to send a weekly RSS Campaign."}},"description":"The schedule for sending the RSS Campaign.","title":"CampaignsRssOptsSchedule"},"CampaignsRssOpts":{"type":"object","properties":{"constrain_rss_img":{"type":"boolean","description":"Whether to add CSS to images in the RSS feed to constrain their width in campaigns."},"feed_url":{"type":"string","format":"uri","description":"The URL for the RSS feed."},"frequency":{"$ref":"#/components/schemas/CampaignsRssOptsFrequency","description":"The frequency of the RSS Campaign."},"last_sent":{"type":"string","format":"date-time","description":"The date the campaign was last sent."},"schedule":{"$ref":"#/components/schemas/CampaignsRssOptsSchedule","description":"The schedule for sending the RSS Campaign."}},"description":"[RSS](https://mailchimp.com/help/share-your-blog-posts-with-mailchimp/) options for a campaign.","title":"CampaignsRssOpts"},"CampaignsSettings":{"type":"object","properties":{"authenticate":{"type":"boolean","description":"Whether Mailchimp [authenticated](https://mailchimp.com/help/about-email-authentication/) the campaign. Defaults to `true`."},"auto_fb_post":{"type":"array","items":{"type":"string"},"description":"An array of [Facebook](https://mailchimp.com/help/connect-or-disconnect-the-facebook-integration/) page ids to auto-post to."},"auto_footer":{"type":"boolean","description":"Automatically append Mailchimp's [default footer](https://mailchimp.com/help/about-campaign-footers/) to the campaign."},"auto_tweet":{"type":"boolean","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."},"drag_and_drop":{"type":"boolean","description":"Whether the campaign uses the drag-and-drop editor."},"fb_comments":{"type":"boolean","description":"Allows Facebook comments on the campaign (also force-enables the Campaign Archive toolbar). Defaults to `true`."},"folder_id":{"type":"string","description":"If the campaign is listed in a folder, the id for that folder."},"from_name":{"type":"string","description":"The 'from' name on the campaign (not an email address)."},"inline_css":{"type":"boolean","description":"Automatically inline the CSS included with the campaign content."},"preview_text":{"type":"string","description":"The preview text for the campaign."},"reply_to":{"type":"string","description":"The reply-to email address for the campaign."},"subject_line":{"type":"string","description":"The subject line for the campaign."},"template_id":{"type":"integer","description":"The id for the template used in this campaign."},"timewarp":{"type":"boolean","description":"Send this campaign using [Timewarp](https://mailchimp.com/help/use-timewarp/)."},"title":{"type":"string","description":"The title of the campaign."},"to_name":{"type":"string","description":"The campaign's custom 'To' name. Typically the first name [audience field](https://mailchimp.com/help/getting-started-with-merge-tags/)."},"use_conversation":{"type":"boolean","description":"Use Mailchimp Conversation feature to manage out-of-office replies."}},"description":"The settings for your campaign, including subject, from name, reply-to address, and more.","title":"CampaignsSettings"},"CampaignsSocialCard":{"type":"object","properties":{"description":{"type":"string","description":"A short summary of the campaign to display."},"image_url":{"type":"string","description":"The url for the header image for the card."},"title":{"type":"string","description":"The title for the card. Typically the subject line of the campaign."}},"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/).","title":"CampaignsSocialCard"},"CampaignsStatus":{"type":"string","enum":["save","paused","schedule","sending","sent","canceled","canceling","archived"],"description":"The current status of the campaign.","title":"CampaignsStatus"},"CampaignTrackingOptionsCapsule":{"type":"object","properties":{"notes":{"type":"boolean","description":"Update contact notes for a campaign based on subscriber email addresses."}},"description":"Deprecated","title":"CampaignTrackingOptionsCapsule"},"CampaignTrackingOptionsSalesforce":{"type":"object","properties":{"campaign":{"type":"boolean","description":"Create a campaign in a connected Salesforce account."},"notes":{"type":"boolean","description":"Update contact notes for a campaign based on subscriber email addresses."}},"description":"Deprecated","title":"CampaignTrackingOptionsSalesforce"},"CampaignTrackingOptions":{"type":"object","properties":{"capsule":{"$ref":"#/components/schemas/CampaignTrackingOptionsCapsule","description":"Deprecated"},"clicktale":{"type":"string","description":"The custom slug for [ClickTale](https://mailchimp.com/help/additional-tracking-options-for-campaigns/) tracking (max of 50 bytes)."},"ecomm360":{"type":"boolean","description":"Whether to enable e-commerce tracking."},"goal_tracking":{"type":"boolean","description":"Deprecated"},"google_analytics":{"type":"string","description":"The custom slug for [Google Analytics](https://mailchimp.com/help/integrate-google-analytics-with-mailchimp/) tracking (max of 50 bytes)."},"html_clicks":{"type":"boolean","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."},"opens":{"type":"boolean","description":"Whether to [track opens](https://mailchimp.com/help/about-open-tracking/). Defaults to `true`. Cannot be set to false for variate campaigns."},"salesforce":{"$ref":"#/components/schemas/CampaignTrackingOptionsSalesforce","description":"Deprecated"},"text_clicks":{"type":"boolean","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."}},"description":"The tracking options for a campaign.","title":"CampaignTrackingOptions"},"CampaignsType":{"type":"string","enum":["regular","plaintext","absplit","rss","variate"],"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.","title":"CampaignsType"},"CampaignsVariateSettingsCombinationsItems":{"type":"object","properties":{"content_description":{"type":"integer","description":"The index of `variate_settings.contents` used."},"from_name":{"type":"integer","description":"The index of `variate_settings.from_names` used."},"id":{"type":"string","description":"Unique ID for the combination."},"recipients":{"type":"integer","description":"The number of recipients for this combination."},"reply_to":{"type":"integer","description":"The index of `variate_settings.reply_to_addresses` used."},"send_time":{"type":"integer","description":"The index of `variate_settings.send_times` used."},"subject_line":{"type":"integer","description":"The index of `variate_settings.subject_lines` used."}},"title":"CampaignsVariateSettingsCombinationsItems"},"CampaignsVariateSettingsWinnerCriteria":{"type":"string","enum":["opens","clicks","manual","total_revenue"],"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.","title":"CampaignsVariateSettingsWinnerCriteria"},"CampaignsVariateSettings":{"type":"object","properties":{"combinations":{"type":"array","items":{"$ref":"#/components/schemas/CampaignsVariateSettingsCombinationsItems"},"description":"Combinations of possible variables used to build emails."},"contents":{"type":"array","items":{"type":"string"},"description":"Descriptions of possible email contents. To set campaign contents, make a PUT request to /campaigns/{campaign_id}/content with the field 'variate_contents'."},"from_names":{"type":"array","items":{"type":"string"},"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."},"reply_to_addresses":{"type":"array","items":{"type":"string"},"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."},"send_times":{"type":"array","items":{"type":"string","format":"date-time"},"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."},"subject_lines":{"type":"array","items":{"type":"string"},"description":"The possible subject lines to test. If no subject lines are provided, settings.subject_line will be used."},"test_size":{"type":"integer","description":"The percentage of recipients to send the test combinations to, must be a value between 10 and 100."},"wait_time":{"type":"integer","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."},"winner_criteria":{"$ref":"#/components/schemas/CampaignsVariateSettingsWinnerCriteria","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."},"winning_campaign_id":{"type":"string","description":"ID of the campaign that was sent to the remaining recipients based on the winning combination."},"winning_combination_id":{"type":"string","description":"ID for the winning combination."}},"description":"The settings specific to A/B test campaigns.","title":"CampaignsVariateSettings"},"Campaigns":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/CampaignsLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"ab_split_opts":{"$ref":"#/components/schemas/ABTestingOptions"},"archive_url":{"type":"string","description":"The link to the campaign's archive version in ISO 8601 format."},"content_type":{"$ref":"#/components/schemas/CampaignsContentType","description":"How the campaign's content is put together."},"create_time":{"type":"string","format":"date-time","description":"The date and time the campaign was created in ISO 8601 format."},"delivery_status":{"$ref":"#/components/schemas/CampaignsDeliveryStatus","description":"Updates on campaigns in the process of sending."},"emails_sent":{"type":"integer","description":"The total number of emails sent for this campaign."},"id":{"type":"string","description":"A string that uniquely identifies this campaign."},"long_archive_url":{"type":"string","description":"The original link to the campaign's archive version."},"needs_block_refresh":{"type":"boolean","description":"Determines if the campaign needs its blocks refreshed by opening the web-based campaign editor. Deprecated and will always return false."},"parent_campaign_id":{"type":"string","description":"If this campaign is the child of another campaign, this identifies the parent campaign. For Example, for RSS or Automation children."},"recipients":{"$ref":"#/components/schemas/CampaignsRecipients","description":"List settings for the campaign."},"report_summary":{"$ref":"#/components/schemas/CampaignsReportSummary","description":"For sent campaigns, a summary of opens, clicks, and e-commerce data."},"resend_shortcut_eligibility":{"$ref":"#/components/schemas/CampaignsResendShortcutEligibility","description":"Determines if the campaign qualifies for the Campaign Resend Shortcuts. Only included when query parameter `include_resend_shortcuts` is `true`."},"resend_shortcut_usage":{"$ref":"#/components/schemas/CampaignsResendShortcutUsage","description":"Information about campaigns related through shortcuts."},"resendable":{"type":"boolean","description":"Determines if the campaign qualifies to be resent to non-openers."},"rss_opts":{"$ref":"#/components/schemas/CampaignsRssOpts","description":"[RSS](https://mailchimp.com/help/share-your-blog-posts-with-mailchimp/) options for a campaign."},"send_time":{"type":"string","format":"date-time","description":"The date and time a campaign was sent."},"settings":{"$ref":"#/components/schemas/CampaignsSettings","description":"The settings for your campaign, including subject, from name, reply-to address, and more."},"social_card":{"$ref":"#/components/schemas/CampaignsSocialCard","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/)."},"status":{"$ref":"#/components/schemas/CampaignsStatus","description":"The current status of the campaign."},"tracking":{"$ref":"#/components/schemas/CampaignTrackingOptions"},"type":{"$ref":"#/components/schemas/CampaignsType","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."},"variate_settings":{"$ref":"#/components/schemas/CampaignsVariateSettings","description":"The settings specific to A/B test campaigns."},"web_id":{"type":"integer","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}`."}},"description":"A summary of an individual campaign's settings and content.","title":"Campaigns"},"campaigns_list_Response_200":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/30CampaignsGetResponsesContentApplicationJsonSchemaLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"campaigns":{"type":"array","items":{"$ref":"#/components/schemas/Campaigns"},"description":"An array of campaigns."},"total_items":{"type":"integer","description":"The total number of items matching the query regardless of pagination."}},"description":"An array of campaigns.","title":"campaigns_list_Response_200"},"30CampaignsPostRequestBodyContentApplicationJsonSchemaContentType":{"type":"string","enum":["template","multichannel"],"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.","title":"30CampaignsPostRequestBodyContentApplicationJsonSchemaContentType"},"30CampaignsPostRequestBodyContentApplicationJsonSchemaRecipientsSegmentOptsMatch":{"type":"string","enum":["any","all"],"description":"Segment match type.","title":"30CampaignsPostRequestBodyContentApplicationJsonSchemaRecipientsSegmentOptsMatch"},"30CampaignsPostRequestBodyContentApplicationJsonSchemaRecipientsSegmentOpts":{"type":"object","properties":{"conditions":{"$ref":"#/components/schemas/SegmentType"},"match":{"$ref":"#/components/schemas/30CampaignsPostRequestBodyContentApplicationJsonSchemaRecipientsSegmentOptsMatch","description":"Segment match type."},"saved_segment_id":{"type":"integer","description":"The id for an existing saved segment."}},"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.","title":"30CampaignsPostRequestBodyContentApplicationJsonSchemaRecipientsSegmentOpts"},"30CampaignsPostRequestBodyContentApplicationJsonSchemaRecipients":{"type":"object","properties":{"list_id":{"type":"string","description":"The unique list id."},"segment_opts":{"$ref":"#/components/schemas/30CampaignsPostRequestBodyContentApplicationJsonSchemaRecipientsSegmentOpts","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."}},"required":["list_id"],"description":"List settings for the campaign.","title":"30CampaignsPostRequestBodyContentApplicationJsonSchemaRecipients"},"30CampaignsPostRequestBodyContentApplicationJsonSchemaRssOptsFrequency":{"type":"string","enum":["daily","weekly","monthly"],"description":"The frequency of the RSS Campaign.","title":"30CampaignsPostRequestBodyContentApplicationJsonSchemaRssOptsFrequency"},"30CampaignsPostRequestBodyContentApplicationJsonSchemaRssOptsScheduleDailySend":{"type":"object","properties":{"friday":{"type":"boolean","description":"Sends the daily RSS Campaign on Fridays."},"monday":{"type":"boolean","description":"Sends the daily RSS Campaign on Mondays."},"saturday":{"type":"boolean","description":"Sends the daily RSS Campaign on Saturdays."},"sunday":{"type":"boolean","description":"Sends the daily RSS Campaign on Sundays."},"thursday":{"type":"boolean","description":"Sends the daily RSS Campaign on Thursdays."},"tuesday":{"type":"boolean","description":"Sends the daily RSS Campaign on Tuesdays."},"wednesday":{"type":"boolean","description":"Sends the daily RSS Campaign on Wednesdays."}},"description":"The days of the week to send a daily RSS Campaign.","title":"30CampaignsPostRequestBodyContentApplicationJsonSchemaRssOptsScheduleDailySend"},"30CampaignsPostRequestBodyContentApplicationJsonSchemaRssOptsScheduleWeeklySendDay":{"type":"string","enum":["sunday","monday","tuesday","wednesday","thursday","friday","saturday"],"description":"The day of the week to send a weekly RSS Campaign.","title":"30CampaignsPostRequestBodyContentApplicationJsonSchemaRssOptsScheduleWeeklySendDay"},"30CampaignsPostRequestBodyContentApplicationJsonSchemaRssOptsSchedule":{"type":"object","properties":{"daily_send":{"$ref":"#/components/schemas/30CampaignsPostRequestBodyContentApplicationJsonSchemaRssOptsScheduleDailySend","description":"The days of the week to send a daily RSS Campaign."},"hour":{"type":"integer","minimum":0,"maximum":23,"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/)."},"monthly_send_date":{"type":"number","format":"double","minimum":0,"maximum":31,"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."},"weekly_send_day":{"$ref":"#/components/schemas/30CampaignsPostRequestBodyContentApplicationJsonSchemaRssOptsScheduleWeeklySendDay","description":"The day of the week to send a weekly RSS Campaign."}},"description":"The schedule for sending the RSS Campaign.","title":"30CampaignsPostRequestBodyContentApplicationJsonSchemaRssOptsSchedule"},"30CampaignsPostRequestBodyContentApplicationJsonSchemaRssOpts":{"type":"object","properties":{"constrain_rss_img":{"type":"boolean","description":"Whether to add CSS to images in the RSS feed to constrain their width in campaigns."},"feed_url":{"type":"string","format":"uri","description":"The URL for the RSS feed."},"frequency":{"$ref":"#/components/schemas/30CampaignsPostRequestBodyContentApplicationJsonSchemaRssOptsFrequency","description":"The frequency of the RSS Campaign."},"schedule":{"$ref":"#/components/schemas/30CampaignsPostRequestBodyContentApplicationJsonSchemaRssOptsSchedule","description":"The schedule for sending the RSS Campaign."}},"required":["feed_url","frequency"],"description":"[RSS](https://mailchimp.com/help/share-your-blog-posts-with-mailchimp/) options, specific to an RSS campaign.","title":"30CampaignsPostRequestBodyContentApplicationJsonSchemaRssOpts"},"30CampaignsPostRequestBodyContentApplicationJsonSchemaSettings":{"type":"object","properties":{"authenticate":{"type":"boolean","description":"Whether Mailchimp [authenticated](https://mailchimp.com/help/about-email-authentication/) the campaign. Defaults to `true`."},"auto_fb_post":{"type":"array","items":{"type":"string"},"description":"An array of [Facebook](https://mailchimp.com/help/connect-or-disconnect-the-facebook-integration/) page ids to auto-post to."},"auto_footer":{"type":"boolean","description":"Automatically append Mailchimp's [default footer](https://mailchimp.com/help/about-campaign-footers/) to the campaign."},"auto_tweet":{"type":"boolean","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."},"fb_comments":{"type":"boolean","description":"Allows Facebook comments on the campaign (also force-enables the Campaign Archive toolbar). Defaults to `true`."},"folder_id":{"type":"string","description":"If the campaign is listed in a folder, the id for that folder."},"from_name":{"type":"string","description":"The 'from' name on the campaign (not an email address)."},"inline_css":{"type":"boolean","description":"Automatically inline the CSS included with the campaign content."},"preview_text":{"type":"string","description":"The preview text for the campaign."},"reply_to":{"type":"string","description":"The reply-to email address for the campaign. Note: while this field is not required for campaign creation, it is required for sending."},"subject_line":{"type":"string","description":"The subject line for the campaign."},"template_id":{"type":"integer","description":"The id of the template to use."},"title":{"type":"string","description":"The title of the campaign."},"to_name":{"type":"string","description":"The campaign's custom 'To' name. Typically the first name [audience field](https://mailchimp.com/help/getting-started-with-merge-tags/)."},"use_conversation":{"type":"boolean","description":"Use Mailchimp Conversation feature to manage out-of-office replies."}},"description":"The settings for your campaign, including subject, from name, reply-to address, and more.","title":"30CampaignsPostRequestBodyContentApplicationJsonSchemaSettings"},"30CampaignsPostRequestBodyContentApplicationJsonSchemaSocialCard":{"type":"object","properties":{"description":{"type":"string","description":"A short summary of the campaign to display."},"image_url":{"type":"string","description":"The url for the header image for the card."},"title":{"type":"string","description":"The title for the card. Typically the subject line of the campaign."}},"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/).","title":"30CampaignsPostRequestBodyContentApplicationJsonSchemaSocialCard"},"30CampaignsPostRequestBodyContentApplicationJsonSchemaType":{"type":"string","enum":["regular","plaintext","absplit","rss","variate"],"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.","title":"30CampaignsPostRequestBodyContentApplicationJsonSchemaType"},"30CampaignsPostRequestBodyContentApplicationJsonSchemaVariateSettingsSendTimesItems":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"}],"title":"30CampaignsPostRequestBodyContentApplicationJsonSchemaVariateSettingsSendTimesItems"},"30CampaignsPostRequestBodyContentApplicationJsonSchemaVariateSettingsWinnerCriteria":{"type":"string","enum":["opens","clicks","manual","total_revenue"],"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.","title":"30CampaignsPostRequestBodyContentApplicationJsonSchemaVariateSettingsWinnerCriteria"},"30CampaignsPostRequestBodyContentApplicationJsonSchemaVariateSettings":{"type":"object","properties":{"from_names":{"type":"array","items":{"type":"string"},"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."},"reply_to_addresses":{"type":"array","items":{"type":"string"},"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."},"send_times":{"type":"array","items":{"$ref":"#/components/schemas/30CampaignsPostRequestBodyContentApplicationJsonSchemaVariateSettingsSendTimesItems"},"description":"The possible send times to test. The times provided should be in the format YYYY-MM-DD HH:MM:SS or ISO 8601 date-time format. If send_times are provided to test, the test_size will be set to 100% and winner_criteria will be ignored."},"subject_lines":{"type":"array","items":{"type":"string"},"description":"The possible subject lines to test. If no subject lines are provided, settings.subject_line will be used."},"test_size":{"type":"integer","description":"The percentage of recipients to send the test combinations to, must be a value between 10 and 100."},"wait_time":{"type":"integer","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."},"winner_criteria":{"$ref":"#/components/schemas/30CampaignsPostRequestBodyContentApplicationJsonSchemaVariateSettingsWinnerCriteria","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."}},"required":["winner_criteria"],"description":"The settings specific to A/B test campaigns.","title":"30CampaignsPostRequestBodyContentApplicationJsonSchemaVariateSettings"},"CampaignLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"CampaignLinksItemsMethod"},"CampaignLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/CampaignLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"CampaignLinksItems"},"CampaignDeliveryStatusStatus":{"type":"string","enum":["delivering","delivered","canceling","canceled"],"description":"The current state of a campaign delivery.","title":"CampaignDeliveryStatusStatus"},"CampaignDeliveryStatus":{"type":"object","properties":{"can_cancel":{"type":"boolean","description":"Whether a campaign send can be canceled."},"emails_canceled":{"type":"integer","description":"The total number of emails canceled for this campaign."},"emails_sent":{"type":"integer","description":"The total number of emails confirmed sent for this campaign so far."},"enabled":{"type":"boolean","description":"Whether Campaign Delivery Status is enabled for this account and campaign."},"status":{"$ref":"#/components/schemas/CampaignDeliveryStatusStatus","description":"The current state of a campaign delivery."}},"description":"Updates on campaigns in the process of sending.","title":"CampaignDeliveryStatus"},"CampaignRecipientsSegmentOptsMatch":{"type":"string","enum":["any","all"],"description":"Segment match type.","title":"CampaignRecipientsSegmentOptsMatch"},"CampaignRecipientsSegmentOptsSavedSegmentId":{"oneOf":[{"type":"integer"},{"type":"string","pattern":"^[0-9]+$"}],"description":"The id for an existing saved segment.","title":"CampaignRecipientsSegmentOptsSavedSegmentId"},"CampaignRecipientsSegmentOpts":{"type":"object","properties":{"conditions":{"$ref":"#/components/schemas/SegmentType"},"match":{"$ref":"#/components/schemas/CampaignRecipientsSegmentOptsMatch","description":"Segment match type."},"prebuilt_segment_id":{"type":"string","description":"The prebuilt segment id, if a prebuilt segment has been designated for this campaign."},"saved_segment_id":{"$ref":"#/components/schemas/CampaignRecipientsSegmentOptsSavedSegmentId","description":"The id for an existing saved segment."}},"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.","title":"CampaignRecipientsSegmentOpts"},"CampaignRecipients":{"type":"object","properties":{"list_id":{"type":"string","description":"The unique list id."},"list_name":{"type":"string","description":"The name of the list."},"recipient_count":{"type":"integer","description":"Count of the recipients on the associated list. Formatted as an integer."},"segment_opts":{"$ref":"#/components/schemas/CampaignRecipientsSegmentOpts","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."},"segment_text":{"type":"string","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."}},"required":["list_id"],"description":"List settings for the campaign.","title":"CampaignRecipients"},"CampaignReportSummaryEcommerce":{"type":"object","properties":{"total_orders":{"type":"integer","description":"The total orders for a campaign."},"total_revenue":{"type":"number","format":"double","description":"The total revenue for a campaign. Calculated as the sum of all order totals minus shipping and tax totals."},"total_spent":{"type":"number","format":"double","description":"The total spent for a campaign. Calculated as the sum of all order totals with no deductions."}},"description":"E-Commerce stats for a campaign.","title":"CampaignReportSummaryEcommerce"},"CampaignReportSummary":{"type":"object","properties":{"click_rate":{"type":"number","format":"double","description":"The number of unique clicks divided by the total number of successful deliveries."},"clicks":{"type":"integer","description":"The total number of clicks for an campaign."},"ecommerce":{"$ref":"#/components/schemas/CampaignReportSummaryEcommerce","description":"E-Commerce stats for a campaign."},"open_rate":{"type":"number","format":"double","description":"The number of unique opens divided by the total number of successful deliveries."},"opens":{"type":"integer","description":"The total number of opens for a campaign."},"subscriber_clicks":{"type":"integer","description":"The number of unique clicks."},"unique_opens":{"type":"integer","description":"The number of unique opens."}},"description":"For sent campaigns, a summary of opens and clicks.","title":"CampaignReportSummary"},"CampaignRssOptsFrequency":{"type":"string","enum":["daily","weekly","monthly"],"description":"The frequency of the RSS Campaign.","title":"CampaignRssOptsFrequency"},"CampaignRssOptsScheduleDailySend":{"type":"object","properties":{"friday":{"type":"boolean","description":"Sends the daily RSS Campaign on Fridays."},"monday":{"type":"boolean","description":"Sends the daily RSS Campaign on Mondays."},"saturday":{"type":"boolean","description":"Sends the daily RSS Campaign on Saturdays."},"sunday":{"type":"boolean","description":"Sends the daily RSS Campaign on Sundays."},"thursday":{"type":"boolean","description":"Sends the daily RSS Campaign on Thursdays."},"tuesday":{"type":"boolean","description":"Sends the daily RSS Campaign on Tuesdays."},"wednesday":{"type":"boolean","description":"Sends the daily RSS Campaign on Wednesdays."}},"description":"The days of the week to send a daily RSS Campaign.","title":"CampaignRssOptsScheduleDailySend"},"CampaignRssOptsScheduleWeeklySendDay":{"type":"string","enum":["sunday","monday","tuesday","wednesday","thursday","friday","saturday"],"description":"The day of the week to send a weekly RSS Campaign.","title":"CampaignRssOptsScheduleWeeklySendDay"},"CampaignRssOptsSchedule":{"type":"object","properties":{"daily_send":{"$ref":"#/components/schemas/CampaignRssOptsScheduleDailySend","description":"The days of the week to send a daily RSS Campaign."},"hour":{"type":"integer","minimum":0,"maximum":23,"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/)."},"monthly_send_date":{"type":"number","format":"double","minimum":0,"maximum":31,"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."},"weekly_send_day":{"$ref":"#/components/schemas/CampaignRssOptsScheduleWeeklySendDay","description":"The day of the week to send a weekly RSS Campaign."}},"description":"The schedule for sending the RSS Campaign.","title":"CampaignRssOptsSchedule"},"CampaignRssOpts":{"type":"object","properties":{"constrain_rss_img":{"type":"boolean","description":"Whether to add CSS to images in the RSS feed to constrain their width in campaigns."},"feed_url":{"type":"string","format":"uri","description":"The URL for the RSS feed."},"frequency":{"$ref":"#/components/schemas/CampaignRssOptsFrequency","description":"The frequency of the RSS Campaign."},"last_sent":{"type":"string","format":"date-time","description":"The date the campaign was last sent."},"schedule":{"$ref":"#/components/schemas/CampaignRssOptsSchedule","description":"The schedule for sending the RSS Campaign."}},"required":["feed_url","frequency"],"description":"[RSS](https://mailchimp.com/help/share-your-blog-posts-with-mailchimp/) options for a campaign.","title":"CampaignRssOpts"},"CampaignSettings":{"type":"object","properties":{"authenticate":{"type":"boolean","description":"Whether Mailchimp [authenticated](https://mailchimp.com/help/about-email-authentication/) the campaign. Defaults to `true`."},"auto_fb_post":{"type":"array","items":{"type":"string"},"description":"An array of [Facebook](https://mailchimp.com/help/connect-or-disconnect-the-facebook-integration/) page ids to auto-post to."},"auto_footer":{"type":"boolean","description":"Automatically append Mailchimp's [default footer](https://mailchimp.com/help/about-campaign-footers/) to the campaign."},"auto_tweet":{"type":"boolean","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."},"drag_and_drop":{"type":"boolean","description":"Whether the campaign uses the drag-and-drop editor."},"fb_comments":{"type":"boolean","description":"Allows Facebook comments on the campaign (also force-enables the Campaign Archive toolbar). Defaults to `true`."},"folder_id":{"type":"string","description":"If the campaign is listed in a folder, the id for that folder."},"from_name":{"type":"string","description":"The 'from' name on the campaign (not an email address)."},"inline_css":{"type":"boolean","description":"Automatically inline the CSS included with the campaign content."},"preview_text":{"type":"string","description":"The preview text for the campaign."},"reply_to":{"type":"string","description":"The reply-to email address for the campaign."},"subject_line":{"type":"string","description":"The subject line for the campaign."},"template_id":{"type":"integer","description":"The id for the template used in this campaign."},"timewarp":{"type":"boolean","description":"Send this campaign using [Timewarp](https://mailchimp.com/help/use-timewarp/)."},"title":{"type":"string","description":"The title of the campaign."},"to_name":{"type":"string","description":"The campaign's custom 'To' name. Typically the first name [audience field](https://mailchimp.com/help/getting-started-with-merge-tags/)."},"use_conversation":{"type":"boolean","description":"Use Mailchimp Conversation feature to manage replies."}},"description":"The settings for your campaign, including subject, from name, reply-to address, and more.","title":"CampaignSettings"},"CampaignSocialCard":{"type":"object","properties":{"description":{"type":"string","description":"A short summary of the campaign to display."},"image_url":{"type":"string","description":"The url for the header image for the card."},"title":{"type":"string","description":"The title for the card. Typically the subject line of the campaign."}},"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/).","title":"CampaignSocialCard"},"CampaignStatus":{"type":"string","enum":["save","paused","schedule","sending","sent","canceled","canceling","archived"],"description":"The current status of the campaign.","title":"CampaignStatus"},"CampaignType":{"type":"string","enum":["regular","plaintext","absplit","rss","variate"],"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.","title":"CampaignType"},"CampaignVariateSettingsCombinationsItems":{"type":"object","properties":{"content_description":{"type":"integer","description":"The index of `variate_settings.contents` used."},"from_name":{"type":"integer","description":"The index of `variate_settings.from_names` used."},"id":{"type":"string","description":"Unique ID for the combination."},"recipients":{"type":"integer","description":"The number of recipients for this combination."},"reply_to":{"type":"integer","description":"The index of `variate_settings.reply_to_addresses` used."},"send_time":{"type":"integer","description":"The index of `variate_settings.send_times` used."},"subject_line":{"type":"integer","description":"The index of `variate_settings.subject_lines` used."}},"title":"CampaignVariateSettingsCombinationsItems"},"CampaignVariateSettingsWinnerCriteria":{"type":"string","enum":["opens","clicks","manual","total_revenue"],"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.","title":"CampaignVariateSettingsWinnerCriteria"},"CampaignVariateSettings":{"type":"object","properties":{"combinations":{"type":"array","items":{"$ref":"#/components/schemas/CampaignVariateSettingsCombinationsItems"},"description":"Combinations of possible variables used to build emails."},"contents":{"type":"array","items":{"type":"string"},"description":"Descriptions of possible email contents. To set campaign contents, make a PUT request to /campaigns/{campaign_id}/content with the field 'variate_contents'."},"from_names":{"type":"array","items":{"type":"string"},"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."},"reply_to_addresses":{"type":"array","items":{"type":"string"},"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."},"send_times":{"type":"array","items":{"type":"string","format":"date-time"},"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."},"subject_lines":{"type":"array","items":{"type":"string"},"description":"The possible subject lines to test. If no subject lines are provided, settings.subject_line will be used."},"test_size":{"type":"integer","description":"The percentage of recipients to send the test combinations to, must be a value between 10 and 100."},"wait_time":{"type":"integer","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."},"winner_criteria":{"$ref":"#/components/schemas/CampaignVariateSettingsWinnerCriteria","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."},"winning_campaign_id":{"type":"string","description":"ID of the campaign that was sent to the remaining recipients based on the winning combination."},"winning_combination_id":{"type":"string","description":"ID for the winning combination."}},"required":["winner_criteria"],"description":"The settings specific to A/B test campaigns.","title":"CampaignVariateSettings"},"Campaign":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/CampaignLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"ab_split_opts":{"$ref":"#/components/schemas/ABTestingOptions"},"archive_url":{"type":"string","description":"The link to the campaign's archive version."},"content_type":{"type":"string","description":"How the campaign's content is put together ('template', 'drag_and_drop', 'html', 'url')."},"create_time":{"type":"string","format":"date-time","description":"The date and time the campaign was created in ISO 8601 format."},"delivery_status":{"$ref":"#/components/schemas/CampaignDeliveryStatus","description":"Updates on campaigns in the process of sending."},"emails_sent":{"type":"integer","description":"The total number of emails sent for this campaign."},"id":{"type":"string","description":"A string that uniquely identifies this campaign."},"long_archive_url":{"type":"string","description":"The original link to the campaign's archive version."},"needs_block_refresh":{"type":"boolean","description":"Determines if the campaign needs its blocks refreshed by opening the web-based campaign editor. Deprecated and will always return false."},"parent_campaign_id":{"type":"string","description":"If this campaign is the child of another campaign, this identifies the parent campaign. For Example, for RSS or Automation children."},"recipients":{"$ref":"#/components/schemas/CampaignRecipients","description":"List settings for the campaign."},"report_summary":{"$ref":"#/components/schemas/CampaignReportSummary","description":"For sent campaigns, a summary of opens and clicks."},"resendable":{"type":"boolean","description":"Determines if the campaign qualifies to be resent to non-openers."},"rss_opts":{"$ref":"#/components/schemas/CampaignRssOpts","description":"[RSS](https://mailchimp.com/help/share-your-blog-posts-with-mailchimp/) options for a campaign."},"send_time":{"type":"string","format":"date-time","description":"The date and time a campaign was sent in ISO 8601 format."},"settings":{"$ref":"#/components/schemas/CampaignSettings","description":"The settings for your campaign, including subject, from name, reply-to address, and more."},"social_card":{"$ref":"#/components/schemas/CampaignSocialCard","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/)."},"status":{"$ref":"#/components/schemas/CampaignStatus","description":"The current status of the campaign."},"tracking":{"$ref":"#/components/schemas/CampaignTrackingOptions"},"type":{"$ref":"#/components/schemas/CampaignType","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."},"variate_settings":{"$ref":"#/components/schemas/CampaignVariateSettings","description":"The settings specific to A/B test campaigns."},"web_id":{"type":"integer","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}`."}},"required":["type"],"description":"A summary of an individual campaign's settings and content.","title":"Campaign"},"30CampaignsCampaignIdPatchRequestBodyContentApplicationJsonSchemaRecipientsSegmentOptsMatch":{"type":"string","enum":["any","all"],"description":"Segment match type.","title":"30CampaignsCampaignIdPatchRequestBodyContentApplicationJsonSchemaRecipientsSegmentOptsMatch"},"30CampaignsCampaignIdPatchRequestBodyContentApplicationJsonSchemaRecipientsSegmentOptsSavedSegmentId":{"oneOf":[{"type":"integer"},{"type":"string","pattern":"^[0-9]+$"}],"description":"The id for an existing saved segment.","title":"30CampaignsCampaignIdPatchRequestBodyContentApplicationJsonSchemaRecipientsSegmentOptsSavedSegmentId"},"30CampaignsCampaignIdPatchRequestBodyContentApplicationJsonSchemaRecipientsSegmentOpts":{"type":"object","properties":{"conditions":{"$ref":"#/components/schemas/SegmentType"},"match":{"$ref":"#/components/schemas/30CampaignsCampaignIdPatchRequestBodyContentApplicationJsonSchemaRecipientsSegmentOptsMatch","description":"Segment match type."},"prebuilt_segment_id":{"type":"string","description":"The prebuilt segment id, if a prebuilt segment has been designated for this campaign."},"saved_segment_id":{"$ref":"#/components/schemas/30CampaignsCampaignIdPatchRequestBodyContentApplicationJsonSchemaRecipientsSegmentOptsSavedSegmentId","description":"The id for an existing saved segment."}},"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.","title":"30CampaignsCampaignIdPatchRequestBodyContentApplicationJsonSchemaRecipientsSegmentOpts"},"30CampaignsCampaignIdPatchRequestBodyContentApplicationJsonSchemaRecipients":{"type":"object","properties":{"list_id":{"type":"string","description":"The unique list id."},"segment_opts":{"$ref":"#/components/schemas/30CampaignsCampaignIdPatchRequestBodyContentApplicationJsonSchemaRecipientsSegmentOpts","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."}},"description":"List settings for the campaign.","title":"30CampaignsCampaignIdPatchRequestBodyContentApplicationJsonSchemaRecipients"},"30CampaignsCampaignIdPatchRequestBodyContentApplicationJsonSchemaRssOptsFrequency":{"type":"string","enum":["daily","weekly","monthly"],"description":"The frequency of the RSS Campaign.","title":"30CampaignsCampaignIdPatchRequestBodyContentApplicationJsonSchemaRssOptsFrequency"},"30CampaignsCampaignIdPatchRequestBodyContentApplicationJsonSchemaRssOptsScheduleDailySend":{"type":"object","properties":{"friday":{"type":"boolean","description":"Sends the daily RSS Campaign on Fridays."},"monday":{"type":"boolean","description":"Sends the daily RSS Campaign on Mondays."},"saturday":{"type":"boolean","description":"Sends the daily RSS Campaign on Saturdays."},"sunday":{"type":"boolean","description":"Sends the daily RSS Campaign on Sundays."},"thursday":{"type":"boolean","description":"Sends the daily RSS Campaign on Thursdays."},"tuesday":{"type":"boolean","description":"Sends the daily RSS Campaign on Tuesdays."},"wednesday":{"type":"boolean","description":"Sends the daily RSS Campaign on Wednesdays."}},"description":"The days of the week to send a daily RSS Campaign.","title":"30CampaignsCampaignIdPatchRequestBodyContentApplicationJsonSchemaRssOptsScheduleDailySend"},"30CampaignsCampaignIdPatchRequestBodyContentApplicationJsonSchemaRssOptsScheduleWeeklySendDay":{"type":"string","enum":["sunday","monday","tuesday","wednesday","thursday","friday","saturday"],"description":"The day of the week to send a weekly RSS Campaign.","title":"30CampaignsCampaignIdPatchRequestBodyContentApplicationJsonSchemaRssOptsScheduleWeeklySendDay"},"30CampaignsCampaignIdPatchRequestBodyContentApplicationJsonSchemaRssOptsSchedule":{"type":"object","properties":{"daily_send":{"$ref":"#/components/schemas/30CampaignsCampaignIdPatchRequestBodyContentApplicationJsonSchemaRssOptsScheduleDailySend","description":"The days of the week to send a daily RSS Campaign."},"hour":{"type":"integer","minimum":0,"maximum":23,"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/)."},"monthly_send_date":{"type":"number","format":"double","minimum":0,"maximum":31,"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."},"weekly_send_day":{"$ref":"#/components/schemas/30CampaignsCampaignIdPatchRequestBodyContentApplicationJsonSchemaRssOptsScheduleWeeklySendDay","description":"The day of the week to send a weekly RSS Campaign."}},"description":"The schedule for sending the RSS Campaign.","title":"30CampaignsCampaignIdPatchRequestBodyContentApplicationJsonSchemaRssOptsSchedule"},"30CampaignsCampaignIdPatchRequestBodyContentApplicationJsonSchemaRssOpts":{"type":"object","properties":{"constrain_rss_img":{"type":"boolean","description":"Whether to add CSS to images in the RSS feed to constrain their width in campaigns."},"feed_url":{"type":"string","format":"uri","description":"The URL for the RSS feed."},"frequency":{"$ref":"#/components/schemas/30CampaignsCampaignIdPatchRequestBodyContentApplicationJsonSchemaRssOptsFrequency","description":"The frequency of the RSS Campaign."},"schedule":{"$ref":"#/components/schemas/30CampaignsCampaignIdPatchRequestBodyContentApplicationJsonSchemaRssOptsSchedule","description":"The schedule for sending the RSS Campaign."}},"description":"[RSS](https://mailchimp.com/help/share-your-blog-posts-with-mailchimp/) options for a campaign.","title":"30CampaignsCampaignIdPatchRequestBodyContentApplicationJsonSchemaRssOpts"},"30CampaignsCampaignIdPatchRequestBodyContentApplicationJsonSchemaSettings":{"type":"object","properties":{"authenticate":{"type":"boolean","description":"Whether Mailchimp [authenticated](https://mailchimp.com/help/about-email-authentication/) the campaign. Defaults to `true`."},"auto_fb_post":{"type":"array","items":{"type":"string"},"description":"An array of [Facebook](https://mailchimp.com/help/connect-or-disconnect-the-facebook-integration/) page ids to auto-post to."},"auto_footer":{"type":"boolean","description":"Automatically append Mailchimp's [default footer](https://mailchimp.com/help/about-campaign-footers/) to the campaign."},"auto_tweet":{"type":"boolean","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."},"fb_comments":{"type":"boolean","description":"Allows Facebook comments on the campaign (also force-enables the Campaign Archive toolbar). Defaults to `true`."},"folder_id":{"type":"string","description":"If the campaign is listed in a folder, the id for that folder."},"from_name":{"type":"string","description":"The 'from' name on the campaign (not an email address)."},"inline_css":{"type":"boolean","description":"Automatically inline the CSS included with the campaign content."},"preview_text":{"type":"string","description":"The preview text for the campaign."},"reply_to":{"type":"string","description":"The reply-to email address for the campaign."},"subject_line":{"type":"string","description":"The subject line for the campaign."},"template_id":{"type":"integer","description":"The id of the template to use."},"title":{"type":"string","description":"The title of the campaign."},"to_name":{"type":"string","description":"The campaign's custom 'To' name. Typically the first name [audience field](https://mailchimp.com/help/getting-started-with-merge-tags/)."},"use_conversation":{"type":"boolean","description":"Use Mailchimp Conversation feature to manage out-of-office replies."}},"description":"The settings for your campaign, including subject, from name, reply-to address, and more.","title":"30CampaignsCampaignIdPatchRequestBodyContentApplicationJsonSchemaSettings"},"30CampaignsCampaignIdPatchRequestBodyContentApplicationJsonSchemaSocialCard":{"type":"object","properties":{"description":{"type":"string","description":"A short summary of the campaign to display."},"image_url":{"type":"string","description":"The url for the header image for the card."},"title":{"type":"string","description":"The title for the card. Typically the subject line of the campaign."}},"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/).","title":"30CampaignsCampaignIdPatchRequestBodyContentApplicationJsonSchemaSocialCard"},"30CampaignsCampaignIdPatchRequestBodyContentApplicationJsonSchemaVariateSettingsSendTimesItems":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"}],"title":"30CampaignsCampaignIdPatchRequestBodyContentApplicationJsonSchemaVariateSettingsSendTimesItems"},"30CampaignsCampaignIdPatchRequestBodyContentApplicationJsonSchemaVariateSettingsWinnerCriteria":{"type":"string","enum":["opens","clicks","manual","total_revenue"],"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.","title":"30CampaignsCampaignIdPatchRequestBodyContentApplicationJsonSchemaVariateSettingsWinnerCriteria"},"30CampaignsCampaignIdPatchRequestBodyContentApplicationJsonSchemaVariateSettings":{"type":"object","properties":{"from_names":{"type":"array","items":{"type":"string"},"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."},"reply_to_addresses":{"type":"array","items":{"type":"string"},"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."},"send_times":{"type":"array","items":{"$ref":"#/components/schemas/30CampaignsCampaignIdPatchRequestBodyContentApplicationJsonSchemaVariateSettingsSendTimesItems"},"description":"The possible send times to test. The times provided should be in the format YYYY-MM-DD HH:MM:SS or ISO 8601 date-time format. If send_times are provided to test, the test_size will be set to 100% and winner_criteria will be ignored."},"subject_lines":{"type":"array","items":{"type":"string"},"description":"The possible subject lines to test. If no subject lines are provided, settings.subject_line will be used."},"test_size":{"type":"integer","description":"The percentage of recipients to send the test combinations to, must be a value between 10 and 100."},"wait_time":{"type":"integer","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."},"winner_criteria":{"$ref":"#/components/schemas/30CampaignsCampaignIdPatchRequestBodyContentApplicationJsonSchemaVariateSettingsWinnerCriteria","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."}},"description":"The settings specific to A/B test campaigns.","title":"30CampaignsCampaignIdPatchRequestBodyContentApplicationJsonSchemaVariateSettings"},"30CampaignsCampaignIdActionsCreateResendPostRequestBodyContentApplicationJsonSchemaShortcutType":{"type":"string","enum":["to_non_openers","to_new_subscribers","to_non_clickers","to_non_purchasers"],"description":"Which campaign resend shortcut to use. Default is `to_non_openers`.","title":"30CampaignsCampaignIdActionsCreateResendPostRequestBodyContentApplicationJsonSchemaShortcutType"},"30CampaignsCampaignIdActionsSchedulePostRequestBodyContentApplicationJsonSchemaBatchDelivery":{"type":"object","properties":{"batch_count":{"type":"integer","description":"The number of batches for the campaign send."},"batch_delay":{"type":"integer","description":"The delay, in minutes, between batches."}},"required":["batch_count","batch_delay"],"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/).","title":"30CampaignsCampaignIdActionsSchedulePostRequestBodyContentApplicationJsonSchemaBatchDelivery"},"30CampaignsCampaignIdActionsTestPostRequestBodyContentApplicationJsonSchemaSendType":{"type":"string","enum":["html","plaintext"],"description":"Choose the type of test email to send.","title":"30CampaignsCampaignIdActionsTestPostRequestBodyContentApplicationJsonSchemaSendType"},"CampaignContentLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"CampaignContentLinksItemsMethod"},"CampaignContentLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/CampaignContentLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"CampaignContentLinksItems"},"CampaignContentVariateContentsItems":{"type":"object","properties":{"content_label":{"type":"string","description":"Label used to identify the content option."},"html":{"type":"string","description":"The raw HTML for the campaign."},"plain_text":{"type":"string","description":"The plain-text portion of the campaign. If left unspecified, we'll generate this automatically."}},"title":"CampaignContentVariateContentsItems"},"CampaignContent":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/CampaignContentLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"archive_html":{"type":"string","description":"The Archive HTML for the campaign."},"html":{"type":"string","description":"The raw HTML for the campaign."},"plain_text":{"type":"string","description":"The plain-text portion of the campaign. If left unspecified, we'll generate this automatically."},"variate_contents":{"type":"array","items":{"$ref":"#/components/schemas/CampaignContentVariateContentsItems"},"description":"Content options for multivariate campaigns."}},"description":"The HTML and plain-text content for a campaign.","title":"CampaignContent"},"30CampaignsCampaignIdSendChecklistGetResponsesContentApplicationJsonSchemaLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"30CampaignsCampaignIdSendChecklistGetResponsesContentApplicationJsonSchemaLinksItemsMethod"},"30CampaignsCampaignIdSendChecklistGetResponsesContentApplicationJsonSchemaLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/30CampaignsCampaignIdSendChecklistGetResponsesContentApplicationJsonSchemaLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"30CampaignsCampaignIdSendChecklistGetResponsesContentApplicationJsonSchemaLinksItems"},"30CampaignsCampaignIdSendChecklistGetResponsesContentApplicationJsonSchemaItemsItemsType":{"type":"string","enum":["success","warning","error"],"description":"The item type.","title":"30CampaignsCampaignIdSendChecklistGetResponsesContentApplicationJsonSchemaItemsItemsType"},"30CampaignsCampaignIdSendChecklistGetResponsesContentApplicationJsonSchemaItemsItems":{"type":"object","properties":{"details":{"type":"string","description":"Details about the specific feedback item."},"heading":{"type":"string","description":"The heading for the specific item."},"id":{"type":"integer","description":"The ID for the specific item."},"type":{"$ref":"#/components/schemas/30CampaignsCampaignIdSendChecklistGetResponsesContentApplicationJsonSchemaItemsItemsType","description":"The item type."}},"title":"30CampaignsCampaignIdSendChecklistGetResponsesContentApplicationJsonSchemaItemsItems"},"campaigns_list-send-checklist_Response_200":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/30CampaignsCampaignIdSendChecklistGetResponsesContentApplicationJsonSchemaLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"is_ready":{"type":"boolean","description":"Whether the campaign is ready to send."},"items":{"type":"array","items":{"$ref":"#/components/schemas/30CampaignsCampaignIdSendChecklistGetResponsesContentApplicationJsonSchemaItemsItems"},"description":"A list of feedback items to review before sending your campaign."}},"description":"The send checklist for the campaign.","title":"campaigns_list-send-checklist_Response_200"},"30CampaignsCampaignIdFeedbackGetResponsesContentApplicationJsonSchemaLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"30CampaignsCampaignIdFeedbackGetResponsesContentApplicationJsonSchemaLinksItemsMethod"},"30CampaignsCampaignIdFeedbackGetResponsesContentApplicationJsonSchemaLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/30CampaignsCampaignIdFeedbackGetResponsesContentApplicationJsonSchemaLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"30CampaignsCampaignIdFeedbackGetResponsesContentApplicationJsonSchemaLinksItems"},"30CampaignsCampaignIdFeedbackGetResponsesContentApplicationJsonSchemaFeedbackItemsLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"30CampaignsCampaignIdFeedbackGetResponsesContentApplicationJsonSchemaFeedbackItemsLinksItemsMethod"},"30CampaignsCampaignIdFeedbackGetResponsesContentApplicationJsonSchemaFeedbackItemsLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/30CampaignsCampaignIdFeedbackGetResponsesContentApplicationJsonSchemaFeedbackItemsLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"30CampaignsCampaignIdFeedbackGetResponsesContentApplicationJsonSchemaFeedbackItemsLinksItems"},"30CampaignsCampaignIdFeedbackGetResponsesContentApplicationJsonSchemaFeedbackItemsSource":{"type":"string","enum":["api","email","sms","web","ios","android"],"description":"The source of the feedback.","title":"30CampaignsCampaignIdFeedbackGetResponsesContentApplicationJsonSchemaFeedbackItemsSource"},"30CampaignsCampaignIdFeedbackGetResponsesContentApplicationJsonSchemaFeedbackItems":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/30CampaignsCampaignIdFeedbackGetResponsesContentApplicationJsonSchemaFeedbackItemsLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"block_id":{"type":"integer","description":"The block id for the editable block that the feedback addresses."},"campaign_id":{"type":"string","description":"The unique id for the campaign."},"created_at":{"type":"string","format":"date-time","description":"The date and time the feedback item was created in ISO 8601 format."},"created_by":{"type":"string","description":"The login name of the user who created the feedback."},"feedback_id":{"type":"integer","description":"The individual id for the feedback item."},"is_complete":{"type":"boolean","description":"The status of feedback."},"message":{"type":"string","description":"The content of the feedback."},"parent_id":{"type":"integer","description":"If a reply, the id of the parent feedback item."},"source":{"$ref":"#/components/schemas/30CampaignsCampaignIdFeedbackGetResponsesContentApplicationJsonSchemaFeedbackItemsSource","description":"The source of the feedback."},"updated_at":{"type":"string","format":"date-time","description":"The date and time the feedback was last updated in ISO 8601 format."}},"required":["message"],"description":"A specific feedback message from a specific campaign.","title":"30CampaignsCampaignIdFeedbackGetResponsesContentApplicationJsonSchemaFeedbackItems"},"campaigns_list-feedback_Response_200":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/30CampaignsCampaignIdFeedbackGetResponsesContentApplicationJsonSchemaLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"campaign_id":{"type":"string","description":"The unique id for the campaign."},"feedback":{"type":"array","items":{"$ref":"#/components/schemas/30CampaignsCampaignIdFeedbackGetResponsesContentApplicationJsonSchemaFeedbackItems"},"description":"A collection of feedback items for a campaign."},"total_items":{"type":"integer","description":"The total number of items matching the query regardless of pagination."}},"description":"A summary of the comment feedback for a specific campaign.","title":"campaigns_list-feedback_Response_200"},"campaigns_create-feedback_Response_200":{"type":"object","properties":{"block_id":{"type":"integer","description":"The block id for the editable block that the feedback addresses."},"is_complete":{"type":"boolean","description":"The status of feedback."},"message":{"type":"string","description":"The content of the feedback."}},"required":["message"],"description":"A specific feedback message from a specific campaign.","title":"campaigns_create-feedback_Response_200"},"CampaignFeedbackLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"CampaignFeedbackLinksItemsMethod"},"CampaignFeedbackLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/CampaignFeedbackLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"CampaignFeedbackLinksItems"},"CampaignFeedbackSource":{"type":"string","enum":["api","email","sms","web","ios","android"],"description":"The source of the feedback.","title":"CampaignFeedbackSource"},"CampaignFeedback":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/CampaignFeedbackLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"block_id":{"type":"integer","description":"The block id for the editable block that the feedback addresses."},"campaign_id":{"type":"string","description":"The unique id for the campaign."},"created_at":{"type":"string","format":"date-time","description":"The date and time the feedback item was created in ISO 8601 format."},"created_by":{"type":"string","description":"The login name of the user who created the feedback."},"feedback_id":{"type":"integer","description":"The individual id for the feedback item."},"is_complete":{"type":"boolean","description":"The status of feedback."},"message":{"type":"string","description":"The content of the feedback."},"parent_id":{"type":"integer","description":"If a reply, the id of the parent feedback item."},"source":{"$ref":"#/components/schemas/CampaignFeedbackSource","description":"The source of the feedback."},"updated_at":{"type":"string","format":"date-time","description":"The date and time the feedback was last updated in ISO 8601 format."}},"description":"A specific feedback message from a specific campaign.","title":"CampaignFeedback"},"30ConnectedSitesGetResponsesContentApplicationJsonSchemaLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"30ConnectedSitesGetResponsesContentApplicationJsonSchemaLinksItemsMethod"},"30ConnectedSitesGetResponsesContentApplicationJsonSchemaLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/30ConnectedSitesGetResponsesContentApplicationJsonSchemaLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"30ConnectedSitesGetResponsesContentApplicationJsonSchemaLinksItems"},"ConnectedSiteLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"ConnectedSiteLinksItemsMethod"},"ConnectedSiteLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/ConnectedSiteLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"ConnectedSiteLinksItems"},"ConnectedSiteSiteScript":{"type":"object","properties":{"fragment":{"type":"string","description":"A pre-built script that you can copy-and-paste into your site to integrate it with Mailchimp."},"url":{"type":"string","description":"The URL used for any integrations that offer built-in support for connected sites."}},"description":"The script used to connect your site with Mailchimp.","title":"ConnectedSiteSiteScript"},"ConnectedSite":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/ConnectedSiteLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"created_at":{"type":"string","format":"date-time","description":"The date and time the connected site was created in ISO 8601 format."},"domain":{"type":"string","description":"The connected site domain."},"foreign_id":{"type":"string","description":"The unique identifier for the site."},"platform":{"type":"string","description":"The platform of the connected site."},"site_script":{"$ref":"#/components/schemas/ConnectedSiteSiteScript","description":"The script used to connect your site with Mailchimp."},"store_id":{"type":"string","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."},"updated_at":{"type":"string","format":"date-time","description":"The date and time the connected site was last updated in ISO 8601 format."}},"description":"Information about a specific connected site.","title":"ConnectedSite"},"connected-sites_list_Response_200":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/30ConnectedSitesGetResponsesContentApplicationJsonSchemaLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"sites":{"type":"array","items":{"$ref":"#/components/schemas/ConnectedSite"},"description":"An array of objects, each representing a connected site."},"total_items":{"type":"integer","description":"The total number of items matching the query regardless of pagination."}},"description":"A collection of connected sites in the account.","title":"connected-sites_list_Response_200"},"30ConversationsGetParametersHasUnreadMessages":{"type":"string","enum":["true","false"],"title":"30ConversationsGetParametersHasUnreadMessages"},"30ConversationsGetResponsesContentApplicationJsonSchemaLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"30ConversationsGetResponsesContentApplicationJsonSchemaLinksItemsMethod"},"30ConversationsGetResponsesContentApplicationJsonSchemaLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/30ConversationsGetResponsesContentApplicationJsonSchemaLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"30ConversationsGetResponsesContentApplicationJsonSchemaLinksItems"},"ConversationLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"ConversationLinksItemsMethod"},"ConversationLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/ConversationLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"ConversationLinksItems"},"ConversationLastMessage":{"type":"object","properties":{"from_email":{"type":"string","description":"A label representing the email of the sender of this message."},"from_label":{"type":"string","description":"A label representing the sender of this message."},"message":{"type":"string","description":"The plain-text content of the message."},"read":{"type":"boolean","description":"Whether this message has been marked as read."},"subject":{"type":"string","description":"The subject of this message."},"timestamp":{"type":"string","format":"date-time","description":"The date and time the message was either sent or received in ISO 8601 format."}},"description":"The most recent message in the conversation.","title":"ConversationLastMessage"},"Conversation":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/ConversationLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"campaign_id":{"type":"string","description":"The unique identifier of the campaign for this conversation."},"from_email":{"type":"string","description":"A label representing the email of the sender of this message."},"from_label":{"type":"string","description":"A label representing the sender of this message."},"id":{"type":"string","description":"A string that uniquely identifies this conversation."},"last_message":{"$ref":"#/components/schemas/ConversationLastMessage","description":"The most recent message in the conversation."},"list_id":{"type":"string","description":"The unique identifier of the list for this conversation."},"message_count":{"type":"integer","description":"The total number of messages in this conversation."},"subject":{"type":"string","description":"The subject of the message."},"unread_messages":{"type":"integer","description":"The number of unread messages in this conversation."}},"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.","title":"Conversation"},"conversations_list_Response_200":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/30ConversationsGetResponsesContentApplicationJsonSchemaLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"conversations":{"type":"array","items":{"$ref":"#/components/schemas/Conversation"},"description":"A list of conversations."},"total_items":{"type":"integer","description":"The total number of items matching the query regardless of pagination."}},"description":"A collection of this account's tracked conversations.","title":"conversations_list_Response_200"},"30ConversationsConversationIdMessagesGetParametersIsRead":{"type":"string","enum":["true","false"],"title":"30ConversationsConversationIdMessagesGetParametersIsRead"},"30ConversationsConversationIdMessagesGetResponsesContentApplicationJsonSchemaLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"30ConversationsConversationIdMessagesGetResponsesContentApplicationJsonSchemaLinksItemsMethod"},"30ConversationsConversationIdMessagesGetResponsesContentApplicationJsonSchemaLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/30ConversationsConversationIdMessagesGetResponsesContentApplicationJsonSchemaLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"30ConversationsConversationIdMessagesGetResponsesContentApplicationJsonSchemaLinksItems"},"ConversationMessageLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"ConversationMessageLinksItemsMethod"},"ConversationMessageLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/ConversationMessageLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"ConversationMessageLinksItems"},"ConversationMessage":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/ConversationMessageLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"conversation_id":{"type":"string","description":"A string that identifies this message's conversation"},"from_email":{"type":"string","description":"A label representing the email of the sender of this message"},"from_label":{"type":"string","description":"A label representing the sender of this message"},"id":{"type":"string","description":"A string that uniquely identifies this message"},"list_id":{"type":"integer","description":"The list's web ID"},"message":{"type":"string","description":"The plain-text content of the message"},"read":{"type":"boolean","description":"Whether this message has been marked as read"},"subject":{"type":"string","description":"The subject of this message"},"timestamp":{"type":"string","format":"date-time","description":"The date and time the message was either sent or received in ISO 8601 format."}},"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.","title":"ConversationMessage"},"conversations_list-messages_Response_200":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/30ConversationsConversationIdMessagesGetResponsesContentApplicationJsonSchemaLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"conversation_id":{"type":"string","description":"A string that identifies this conversation."},"conversation_messages":{"type":"array","items":{"$ref":"#/components/schemas/ConversationMessage"},"description":"An array of objects, each representing a conversation messages resources."},"total_items":{"type":"integer","description":"The total number of items matching the query regardless of pagination."}},"description":"Messages from a specific conversation.","title":"conversations_list-messages_Response_200"},"30EcommerceGetResponsesContentApplicationJsonSchemaLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"30EcommerceGetResponsesContentApplicationJsonSchemaLinksItemsMethod"},"30EcommerceGetResponsesContentApplicationJsonSchemaLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/30EcommerceGetResponsesContentApplicationJsonSchemaLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"30EcommerceGetResponsesContentApplicationJsonSchemaLinksItems"},"ecommerce_list_Response_200":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/30EcommerceGetResponsesContentApplicationJsonSchemaLinksItems"},"description":"A list of link types and descriptions for the API schema documents."}},"description":"This resource serves as a namespace for e-commerce-related resources.","title":"ecommerce_list_Response_200"},"30EcommerceOrdersGetResponsesContentApplicationJsonSchemaLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"30EcommerceOrdersGetResponsesContentApplicationJsonSchemaLinksItemsMethod"},"30EcommerceOrdersGetResponsesContentApplicationJsonSchemaLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/30EcommerceOrdersGetResponsesContentApplicationJsonSchemaLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"30EcommerceOrdersGetResponsesContentApplicationJsonSchemaLinksItems"},"ECommerceOrderLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"ECommerceOrderLinksItemsMethod"},"ECommerceOrderLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/ECommerceOrderLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"ECommerceOrderLinksItems"},"ECommerceOrderBillingAddress":{"type":"object","properties":{"address1":{"type":"string","description":"The billing address for the order."},"address2":{"type":"string","description":"An additional field for the billing address."},"city":{"type":"string","description":"The city in the billing address."},"company":{"type":"string","description":"The company associated with the billing address."},"country":{"type":"string","description":"The country in the billing address."},"country_code":{"type":"string","description":"The two-letter code for the country in the billing address."},"latitude":{"type":"number","format":"double","description":"The latitude for the billing address location."},"longitude":{"type":"number","format":"double","description":"The longitude for the billing address location."},"name":{"type":"string","description":"The name associated with an order's billing address."},"phone":{"type":"string","description":"The phone number for the billing address."},"postal_code":{"type":"string","description":"The postal or zip code in the billing address."},"province":{"type":"string","description":"The state or normalized province in the billing address."},"province_code":{"type":"string","description":"The two-letter code for the province or state in the billing address."}},"description":"The billing address for the order.","title":"ECommerceOrderBillingAddress"},"ECommerceCustomerLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"ECommerceCustomerLinksItemsMethod"},"ECommerceCustomerLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/ECommerceCustomerLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"ECommerceCustomerLinksItems"},"ECommerceCustomerAddress":{"type":"object","properties":{"address1":{"type":"string","description":"The mailing address of the customer."},"address2":{"type":"string","description":"An additional field for the customer's mailing address."},"city":{"type":"string","description":"The city the customer is located in."},"country":{"type":"string","description":"The customer's country."},"country_code":{"type":"string","description":"The two-letter code for the customer's country."},"postal_code":{"type":"string","description":"The customer's postal or zip code."},"province":{"type":"string","description":"The customer's state name or normalized province."},"province_code":{"type":"string","description":"The two-letter code for the customer's province or state."}},"description":"The customer's address.","title":"ECommerceCustomerAddress"},"ECommerceCustomerTotalSpent":{"oneOf":[{"type":"number","format":"double"},{"type":"string","pattern":"^\\s*[+-]?(?:[0-9]+\\.?[0-9]*|\\.[0-9]+)(?:[eE][+-]?[0-9]+)?\\s*$"}],"title":"ECommerceCustomerTotalSpent"},"ECommerceCustomer":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/ECommerceCustomerLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"address":{"$ref":"#/components/schemas/ECommerceCustomerAddress","description":"The customer's address."},"company":{"type":"string","description":"The customer's company."},"created_at":{"type":"string","format":"date-time","description":"The date and time the customer was created in ISO 8601 format."},"email_address":{"type":"string","description":"The customer's email address."},"first_name":{"type":"string","description":"The customer's first name."},"id":{"type":"string","description":"A unique identifier for the customer."},"last_name":{"type":"string","description":"The customer's last name."},"opt_in_status":{"type":"boolean","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)."},"orders_count":{"type":"integer","description":"The customer's total order count."},"sms_phone_number":{"type":"string","description":"A US phone number for SMS contact."},"total_spent":{"$ref":"#/components/schemas/ECommerceCustomerTotalSpent"},"updated_at":{"type":"string","format":"date-time","description":"The date and time the customer was last updated in ISO 8601 format."}},"description":"Information about a specific customer.","title":"ECommerceCustomer"},"ECommerceOrderLineItemLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"ECommerceOrderLineItemLinksItemsMethod"},"ECommerceOrderLineItemLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/ECommerceOrderLineItemLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"ECommerceOrderLineItemLinksItems"},"ECommerceOrderLineItemPrice":{"oneOf":[{"type":"number","format":"double"},{"type":"string","pattern":"^\\s*[+-]?(?:[0-9]+\\.?[0-9]*|\\.[0-9]+)(?:[eE][+-]?[0-9]+)?\\s*$"}],"title":"ECommerceOrderLineItemPrice"},"ECommerceOrderLineItem":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/ECommerceOrderLineItemLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"discount":{"type":"number","format":"double","description":"The total discount amount applied to a line item."},"id":{"type":"string","description":"A unique identifier for an order line item."},"image_url":{"type":"string","description":"The image URL for a product."},"price":{"$ref":"#/components/schemas/ECommerceOrderLineItemPrice"},"product_id":{"type":"string","description":"A unique identifier for the product associated with an order line item."},"product_title":{"type":"string","description":"The name of the product for an order line item."},"product_variant_id":{"type":"string","description":"A unique identifier for the product variant associated with an order line item."},"product_variant_title":{"type":"string","description":"The name of the product variant for an order line item."},"quantity":{"type":"integer","description":"The order line item quantity."}},"description":"Information about a specific order line.","title":"ECommerceOrderLineItem"},"ECommerceOrderOrderTotal":{"oneOf":[{"type":"number","format":"double"},{"type":"string","pattern":"^\\s*[+-]?(?:[0-9]+\\.?[0-9]*|\\.[0-9]+)(?:[eE][+-]?[0-9]+)?\\s*$"}],"title":"ECommerceOrderOrderTotal"},"ECommerceOrderOutreach":{"type":"object","properties":{"id":{"type":"string","description":"A unique identifier for the outreach. Can be an email campaign ID."},"name":{"type":"string","description":"The name for the outreach."},"published_time":{"type":"string","format":"date-time","description":"The date and time the Outreach was published in ISO 8601 format."},"type":{"type":"string","description":"The type of the outreach."}},"description":"The outreach associated with this order. For example, an email campaign or Facebook ad.","title":"ECommerceOrderOutreach"},"ECommerceOrderPromosItemsType":{"type":"string","enum":["fixed","percentage"],"description":"Type of discount. For free shipping set type to fixed","title":"ECommerceOrderPromosItemsType"},"ECommerceOrderPromosItems":{"type":"object","properties":{"amount_discounted":{"type":"number","format":"double","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"},"code":{"type":"string","description":"The Promo Code"},"type":{"$ref":"#/components/schemas/ECommerceOrderPromosItemsType","description":"Type of discount. For free shipping set type to fixed"}},"title":"ECommerceOrderPromosItems"},"ECommerceOrderShippingAddress":{"type":"object","properties":{"address1":{"type":"string","description":"The shipping address for the order."},"address2":{"type":"string","description":"An additional field for the shipping address."},"city":{"type":"string","description":"The city in the order's shipping address."},"company":{"type":"string","description":"The company associated with an order's shipping address."},"country":{"type":"string","description":"The country in the order's shipping address."},"country_code":{"type":"string","description":"The two-letter code for the country in the shipping address."},"latitude":{"type":"number","format":"double","description":"The latitude for the shipping address location."},"longitude":{"type":"number","format":"double","description":"The longitude for the shipping address location."},"name":{"type":"string","description":"The name associated with an order's shipping address."},"phone":{"type":"string","description":"The phone number for the order's shipping address"},"postal_code":{"type":"string","description":"The postal or zip code in the order's shipping address."},"province":{"type":"string","description":"The state or normalized province in the order's shipping address."},"province_code":{"type":"string","description":"The two-letter code for the province or state the order's shipping address is located in."}},"description":"The shipping address for the order.","title":"ECommerceOrderShippingAddress"},"ECommerceOrderShippingTotal":{"oneOf":[{"type":"number","format":"double"},{"type":"string","pattern":"^\\s*[+-]?(?:[0-9]+\\.?[0-9]*|\\.[0-9]+)(?:[eE][+-]?[0-9]+)?\\s*$"}],"title":"ECommerceOrderShippingTotal"},"ECommerceOrderTaxTotal":{"oneOf":[{"type":"number","format":"double"},{"type":"string","pattern":"^\\s*[+-]?(?:[0-9]+\\.?[0-9]*|\\.[0-9]+)(?:[eE][+-]?[0-9]+)?\\s*$"}],"title":"ECommerceOrderTaxTotal"},"ECommerceOrderTrackingCode":{"type":"string","enum":["prec"],"description":"The Mailchimp tracking code for the order. Uses the 'mc_tc' parameter in E-Commerce tracking URLs.","title":"ECommerceOrderTrackingCode"},"ECommerceOrder":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/ECommerceOrderLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"billing_address":{"$ref":"#/components/schemas/ECommerceOrderBillingAddress","description":"The billing address for the order."},"campaign_id":{"type":"string","description":"A string that uniquely identifies the campaign associated with an order."},"cart_id":{"type":"string","description":"A cart id that the order was placed for."},"cancelled_at_foreign":{"type":"string","format":"date-time","description":"The date and time the order was cancelled in ISO 8601 format."},"currency_code":{"type":"string","description":"The three-letter ISO 4217 code for the currency that the store accepts."},"customer":{"$ref":"#/components/schemas/ECommerceCustomer"},"discount_total":{"type":"number","format":"double","description":"The total amount of the discounts to be applied to the price of the order."},"financial_status":{"type":"string","description":"The order status. Use this parameter to trigger [Order Notifications](https://mailchimp.com/developer/marketing/docs/e-commerce/#order-notifications)."},"fulfillment_status":{"type":"string","description":"The fulfillment status for the order. Use this parameter to trigger [Order Notifications](https://mailchimp.com/developer/marketing/docs/e-commerce/#order-notifications)."},"id":{"type":"string","description":"A unique identifier for the order."},"landing_site":{"type":"string","description":"The URL for the page where the buyer landed when entering the shop."},"lines":{"type":"array","items":{"$ref":"#/components/schemas/ECommerceOrderLineItem"},"description":"An array of the order's line items."},"order_total":{"$ref":"#/components/schemas/ECommerceOrderOrderTotal"},"order_url":{"type":"string","description":"The URL for the order."},"outreach":{"$ref":"#/components/schemas/ECommerceOrderOutreach","description":"The outreach associated with this order. For example, an email campaign or Facebook ad."},"processed_at_foreign":{"type":"string","format":"date-time","description":"The date and time the order was processed in ISO 8601 format."},"promos":{"type":"array","items":{"$ref":"#/components/schemas/ECommerceOrderPromosItems"},"description":"The promo codes applied on the order"},"shipping_address":{"$ref":"#/components/schemas/ECommerceOrderShippingAddress","description":"The shipping address for the order."},"shipping_total":{"$ref":"#/components/schemas/ECommerceOrderShippingTotal"},"store_id":{"type":"string","description":"The unique identifier for the store."},"tax_total":{"$ref":"#/components/schemas/ECommerceOrderTaxTotal"},"tracking_carrier":{"type":"string","description":"The tracking carrier associated with the order."},"tracking_code":{"$ref":"#/components/schemas/ECommerceOrderTrackingCode","description":"The Mailchimp tracking code for the order. Uses the 'mc_tc' parameter in E-Commerce tracking URLs."},"tracking_number":{"type":"string","description":"The tracking number associated with the order."},"tracking_url":{"type":"string","description":"The tracking URL associated with the order."},"updated_at_foreign":{"type":"string","format":"date-time","description":"The date and time the order was updated in ISO 8601 format."}},"description":"Information about a specific order.","title":"ECommerceOrder"},"ecommerce_list-orders_Response_200":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/30EcommerceOrdersGetResponsesContentApplicationJsonSchemaLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"orders":{"type":"array","items":{"$ref":"#/components/schemas/ECommerceOrder"},"description":"An array of objects, each representing an order resource."},"total_items":{"type":"integer","description":"The total number of items matching the query regardless of pagination."}},"description":"A collection of orders in an account.","title":"ecommerce_list-orders_Response_200"},"30EcommerceStoresGetResponsesContentApplicationJsonSchemaLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"30EcommerceStoresGetResponsesContentApplicationJsonSchemaLinksItemsMethod"},"30EcommerceStoresGetResponsesContentApplicationJsonSchemaLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/30EcommerceStoresGetResponsesContentApplicationJsonSchemaLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"30EcommerceStoresGetResponsesContentApplicationJsonSchemaLinksItems"},"ECommerceStoreLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"ECommerceStoreLinksItemsMethod"},"ECommerceStoreLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/ECommerceStoreLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"ECommerceStoreLinksItems"},"ECommerceStoreAddress":{"type":"object","properties":{"address1":{"type":"string","description":"The store's mailing address."},"address2":{"type":"string","description":"An additional field for the store's mailing address."},"city":{"type":"string","description":"The city the store is located in."},"country":{"type":"string","description":"The store's country."},"country_code":{"type":"string","description":"The two-letter code for to the store's country."},"latitude":{"type":"number","format":"double","description":"The latitude of the store location."},"longitude":{"type":"number","format":"double","description":"The longitude of the store location."},"postal_code":{"type":"string","description":"The store's postal or zip code."},"province":{"type":"string","description":"The store's state name or normalized province."},"province_code":{"type":"string","description":"The two-letter code for the store's province or state."}},"description":"The store address.","title":"ECommerceStoreAddress"},"ECommerceStoreAutomationsAbandonedBrowseStatus":{"type":"string","enum":["save","sending","paused"],"description":"Status of the abandonedBrowse automation.","title":"ECommerceStoreAutomationsAbandonedBrowseStatus"},"ECommerceStoreAutomationsAbandonedBrowse":{"type":"object","properties":{"id":{"type":"string","description":"Unique ID of automation parent campaign."},"is_supported":{"type":"boolean","description":"Whether this store supports the abandonedBrowse automation."},"status":{"$ref":"#/components/schemas/ECommerceStoreAutomationsAbandonedBrowseStatus","description":"Status of the abandonedBrowse automation."}},"description":"abandonedBrowse automation details. abandonedBrowse is also known as Product Retargeting Email or Retarget Site Visitors on the web.","title":"ECommerceStoreAutomationsAbandonedBrowse"},"ECommerceStoreAutomationsAbandonedCartStatus":{"type":"string","enum":["save","sending","paused"],"description":"Status of the abandonedCart automation.","title":"ECommerceStoreAutomationsAbandonedCartStatus"},"ECommerceStoreAutomationsAbandonedCart":{"type":"object","properties":{"id":{"type":"string","description":"Unique ID of automation parent campaign."},"is_supported":{"type":"boolean","description":"Whether this store supports the abandonedCart automation."},"status":{"$ref":"#/components/schemas/ECommerceStoreAutomationsAbandonedCartStatus","description":"Status of the abandonedCart automation."}},"description":"abandonedCart automation details.","title":"ECommerceStoreAutomationsAbandonedCart"},"ECommerceStoreAutomations":{"type":"object","properties":{"abandoned_browse":{"$ref":"#/components/schemas/ECommerceStoreAutomationsAbandonedBrowse","description":"abandonedBrowse automation details. abandonedBrowse is also known as Product Retargeting Email or Retarget Site Visitors on the web."},"abandoned_cart":{"$ref":"#/components/schemas/ECommerceStoreAutomationsAbandonedCart","description":"abandonedCart automation details."}},"description":"Details for the automations attached to this store.","title":"ECommerceStoreAutomations"},"ECommerceStoreConnectedSiteSiteScript":{"type":"object","properties":{"fragment":{"type":"string","description":"A pre-built script that you can copy-and-paste into your site to integrate it with Mailchimp."},"url":{"type":"string","description":"The URL used for any integrations that offer built-in support for connected sites."}},"description":"The script used to connect your site with Mailchimp.","title":"ECommerceStoreConnectedSiteSiteScript"},"ECommerceStoreConnectedSite":{"type":"object","properties":{"site_foreign_id":{"type":"string","description":"The unique identifier for the connected site."},"site_script":{"$ref":"#/components/schemas/ECommerceStoreConnectedSiteSiteScript","description":"The script used to connect your site with Mailchimp."}},"description":"The Connected Site associated with the store.","title":"ECommerceStoreConnectedSite"},"ECommerceStore":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/ECommerceStoreLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"address":{"$ref":"#/components/schemas/ECommerceStoreAddress","description":"The store address."},"automations":{"$ref":"#/components/schemas/ECommerceStoreAutomations","description":"Details for the automations attached to this store."},"connected_site":{"$ref":"#/components/schemas/ECommerceStoreConnectedSite","description":"The Connected Site associated with the store."},"created_at":{"type":"string","format":"date-time","description":"The date and time the store was created in ISO 8601 format."},"currency_code":{"type":"string","description":"The three-letter ISO 4217 code for the currency that the store accepts."},"domain":{"type":"string","description":"The store domain.  The store domain must be unique within a user account."},"email_address":{"type":"string","description":"The email address for the store."},"id":{"type":"string","description":"The unique identifier for the store."},"is_syncing":{"type":"boolean","description":"Whether to disable automations because the store is currently [syncing](https://mailchimp.com/developer/marketing/docs/e-commerce/#pausing-store-automations)."},"list_id":{"type":"string","description":"The unique identifier for the list that's associated with the store. The `list_id` for a specific store can't change."},"list_is_active":{"type":"boolean","description":"The status of the list connected to the store, namely if it's deleted or disabled."},"money_format":{"type":"string","description":"The currency format for the store. For example: `$`, `£`, etc."},"name":{"type":"string","description":"The name of the store."},"phone":{"type":"string","description":"The store phone number."},"platform":{"type":"string","description":"The e-commerce platform of the store."},"primary_locale":{"type":"string","description":"The primary locale for the store. For example: `en`, `de`, etc."},"timezone":{"type":"string","description":"The timezone for the store."},"updated_at":{"type":"string","format":"date-time","description":"The date and time the store was last updated in ISO 8601 format."}},"description":"An individual store in an account.","title":"ECommerceStore"},"ecommerce_list-stores_Response_200":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/30EcommerceStoresGetResponsesContentApplicationJsonSchemaLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"stores":{"type":"array","items":{"$ref":"#/components/schemas/ECommerceStore"},"description":"An array of objects, each representing a store."},"total_items":{"type":"integer","description":"The total number of items matching the query regardless of pagination."}},"description":"A collection of stores in the account.","title":"ecommerce_list-stores_Response_200"},"30EcommerceStoresPostRequestBodyContentApplicationJsonSchemaAddressLatitude":{"oneOf":[{"type":"number","format":"double"},{"type":"string","pattern":"^-?[0-9]+\\.?[0-9]*$"}],"description":"The latitude of the store location.","title":"30EcommerceStoresPostRequestBodyContentApplicationJsonSchemaAddressLatitude"},"30EcommerceStoresPostRequestBodyContentApplicationJsonSchemaAddressLongitude":{"oneOf":[{"type":"number","format":"double"},{"type":"string","pattern":"^-?[0-9]+\\.?[0-9]*$"}],"description":"The longitude of the store location.","title":"30EcommerceStoresPostRequestBodyContentApplicationJsonSchemaAddressLongitude"},"30EcommerceStoresPostRequestBodyContentApplicationJsonSchemaAddress":{"type":"object","properties":{"address1":{"type":"string","description":"The store's mailing address."},"address2":{"type":"string","description":"An additional field for the store's mailing address."},"city":{"type":"string","description":"The city the store is located in."},"country":{"type":"string","description":"The store's country."},"country_code":{"type":"string","description":"The two-letter code for to the store's country."},"latitude":{"$ref":"#/components/schemas/30EcommerceStoresPostRequestBodyContentApplicationJsonSchemaAddressLatitude","description":"The latitude of the store location."},"longitude":{"$ref":"#/components/schemas/30EcommerceStoresPostRequestBodyContentApplicationJsonSchemaAddressLongitude","description":"The longitude of the store location."},"postal_code":{"type":"string","description":"The store's postal or zip code."},"province":{"type":"string","description":"The store's state name or normalized province."},"province_code":{"type":"string","description":"The two-letter code for the store's province or state."}},"description":"The store address.","title":"30EcommerceStoresPostRequestBodyContentApplicationJsonSchemaAddress"},"30EcommerceStoresStoreIdPatchRequestBodyContentApplicationJsonSchemaAddressLatitude":{"oneOf":[{"type":"number","format":"double"},{"type":"string","pattern":"^-?[0-9]+\\.?[0-9]*$"}],"description":"The latitude of the store location.","title":"30EcommerceStoresStoreIdPatchRequestBodyContentApplicationJsonSchemaAddressLatitude"},"30EcommerceStoresStoreIdPatchRequestBodyContentApplicationJsonSchemaAddressLongitude":{"oneOf":[{"type":"number","format":"double"},{"type":"string","pattern":"^-?[0-9]+\\.?[0-9]*$"}],"description":"The longitude of the store location.","title":"30EcommerceStoresStoreIdPatchRequestBodyContentApplicationJsonSchemaAddressLongitude"},"30EcommerceStoresStoreIdPatchRequestBodyContentApplicationJsonSchemaAddress":{"type":"object","properties":{"address1":{"type":"string","description":"The store's mailing address."},"address2":{"type":"string","description":"An additional field for the store's mailing address."},"city":{"type":"string","description":"The city the store is located in."},"country":{"type":"string","description":"The store's country."},"country_code":{"type":"string","description":"The two-letter code for to the store's country."},"latitude":{"$ref":"#/components/schemas/30EcommerceStoresStoreIdPatchRequestBodyContentApplicationJsonSchemaAddressLatitude","description":"The latitude of the store location."},"longitude":{"$ref":"#/components/schemas/30EcommerceStoresStoreIdPatchRequestBodyContentApplicationJsonSchemaAddressLongitude","description":"The longitude of the store location."},"postal_code":{"type":"string","description":"The store's postal or zip code."},"province":{"type":"string","description":"The store's state name or normalized province."},"province_code":{"type":"string","description":"The two-letter code for the store's province or state."}},"description":"The store address.","title":"30EcommerceStoresStoreIdPatchRequestBodyContentApplicationJsonSchemaAddress"},"30EcommerceStoresStoreIdCartsGetResponsesContentApplicationJsonSchemaLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"30EcommerceStoresStoreIdCartsGetResponsesContentApplicationJsonSchemaLinksItemsMethod"},"30EcommerceStoresStoreIdCartsGetResponsesContentApplicationJsonSchemaLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/30EcommerceStoresStoreIdCartsGetResponsesContentApplicationJsonSchemaLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"30EcommerceStoresStoreIdCartsGetResponsesContentApplicationJsonSchemaLinksItems"},"ECommerceCartLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"ECommerceCartLinksItemsMethod"},"ECommerceCartLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/ECommerceCartLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"ECommerceCartLinksItems"},"ECommerceCartLineItemLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"ECommerceCartLineItemLinksItemsMethod"},"ECommerceCartLineItemLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/ECommerceCartLineItemLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"ECommerceCartLineItemLinksItems"},"ECommerceCartLineItem":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/ECommerceCartLineItemLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"id":{"type":"string","description":"A unique identifier for the cart line item."},"price":{"type":"number","format":"double","description":"The price of a cart line item."},"product_id":{"type":"string","description":"A unique identifier for the product associated with the cart line item."},"product_title":{"type":"string","description":"The name of the product for the cart line item."},"product_variant_id":{"type":"string","description":"A unique identifier for the product variant associated with the cart line item."},"product_variant_title":{"type":"string","description":"The name of the product variant for the cart line item."},"quantity":{"type":"integer","description":"The quantity of a cart line item."}},"description":"Information about a specific cart line item.","title":"ECommerceCartLineItem"},"ECommerceCart":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/ECommerceCartLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"campaign_id":{"type":"string","description":"A string that uniquely identifies the campaign associated with a cart."},"checkout_url":{"type":"string","description":"The URL for the cart. This parameter is required for [Abandoned Cart](https://mailchimp.com/help/create-a-classic-abandoned-cart-email/) automations."},"created_at":{"type":"string","format":"date-time","description":"The date and time the cart was created in ISO 8601 format."},"currency_code":{"type":"string","description":"The three-letter ISO 4217 code for the currency that the cart uses."},"customer":{"$ref":"#/components/schemas/ECommerceCustomer"},"id":{"type":"string","description":"A unique identifier for the cart."},"lines":{"type":"array","items":{"$ref":"#/components/schemas/ECommerceCartLineItem"},"description":"An array of the cart's line items."},"order_total":{"type":"number","format":"double","description":"The order total for the cart."},"tax_total":{"type":"number","format":"double","description":"The total tax for the cart."},"updated_at":{"type":"string","format":"date-time","description":"The date and time the cart was last updated in ISO 8601 format."}},"description":"Information about a specific cart.","title":"ECommerceCart"},"ecommerce_list-store-carts_Response_200":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/30EcommerceStoresStoreIdCartsGetResponsesContentApplicationJsonSchemaLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"carts":{"type":"array","items":{"$ref":"#/components/schemas/ECommerceCart"},"description":"An array of objects, each representing a cart."},"store_id":{"type":"string","description":"The store id."},"total_items":{"type":"integer","description":"The total number of items matching the query regardless of pagination."}},"description":"A collection of a store's carts.","title":"ecommerce_list-store-carts_Response_200"},"EcommerceStoresCartsPostAddress":{"type":"object","properties":{"address1":{"type":"string","description":"The mailing address of the customer."},"address2":{"type":"string","description":"An additional field for the customer's mailing address."},"city":{"type":"string","description":"The city the customer is located in."},"country":{"type":"string","description":"The customer's country."},"country_code":{"type":"string","description":"The two-letter code for the customer's country."},"postal_code":{"type":"string","description":"The customer's postal or zip code."},"province":{"type":"string","description":"The customer's state name or normalized province."},"province_code":{"type":"string","description":"The two-letter code for the customer's province or state."}},"description":"The customer's address.","title":"EcommerceStoresCartsPostAddress"},"EcommerceStoresCartsPost":{"type":"object","properties":{"address":{"$ref":"#/components/schemas/EcommerceStoresCartsPostAddress","description":"The customer's address."},"company":{"type":"string","description":"The customer's company."},"email_address":{"type":"string","description":"The customer's email address."},"first_name":{"type":"string","description":"The customer's first name."},"id":{"type":"string","minLength":1,"maxLength":50,"description":"A unique identifier for the customer. Limited to 50 characters."},"last_name":{"type":"string","description":"The customer's last name."},"opt_in_status":{"type":"boolean","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)."}},"required":["id"],"description":"Information about a specific customer. For existing customers include only the `id` parameter in the `customer` object body.","title":"EcommerceStoresCartsPost"},"30EcommerceStoresStoreIdCartsPostRequestBodyContentApplicationJsonSchemaId":{"oneOf":[{"type":"string","pattern":"\\S","minLength":1},{"type":"integer"}],"description":"A unique identifier for the cart.","title":"30EcommerceStoresStoreIdCartsPostRequestBodyContentApplicationJsonSchemaId"},"30EcommerceStoresStoreIdCartsPostRequestBodyContentApplicationJsonSchemaLinesItemsPrice":{"oneOf":[{"type":"number","format":"double"},{"type":"string","pattern":"^\\s*[+-]?(?:[0-9]+\\.?[0-9]*|\\.[0-9]+)(?:[eE][+-]?[0-9]+)?\\s*$"}],"title":"30EcommerceStoresStoreIdCartsPostRequestBodyContentApplicationJsonSchemaLinesItemsPrice"},"30EcommerceStoresStoreIdCartsPostRequestBodyContentApplicationJsonSchemaLinesItems":{"type":"object","properties":{"id":{"type":"string","minLength":1,"description":"A unique identifier for the cart line item."},"price":{"$ref":"#/components/schemas/30EcommerceStoresStoreIdCartsPostRequestBodyContentApplicationJsonSchemaLinesItemsPrice"},"product_id":{"type":"string","description":"A unique identifier for the product associated with the cart line item."},"product_variant_id":{"type":"string","description":"A unique identifier for the product variant associated with the cart line item."},"quantity":{"type":"integer","description":"The quantity of a cart line item."}},"required":["id","price","product_id","product_variant_id","quantity"],"description":"Information about a specific cart line item.","title":"30EcommerceStoresStoreIdCartsPostRequestBodyContentApplicationJsonSchemaLinesItems"},"30EcommerceStoresStoreIdCartsPostRequestBodyContentApplicationJsonSchemaOrderTotal":{"oneOf":[{"type":"number","format":"double"},{"type":"string","pattern":"^\\s*[+-]?(?:[0-9]+\\.?[0-9]*|\\.[0-9]+)(?:[eE][+-]?[0-9]+)?\\s*$"}],"title":"30EcommerceStoresStoreIdCartsPostRequestBodyContentApplicationJsonSchemaOrderTotal"},"30EcommerceStoresStoreIdCartsPostRequestBodyContentApplicationJsonSchemaTaxTotal":{"oneOf":[{"type":"number","format":"double"},{"type":"string","pattern":"^\\s*[+-]?(?:[0-9]+\\.?[0-9]*|\\.[0-9]+)(?:[eE][+-]?[0-9]+)?\\s*$"}],"title":"30EcommerceStoresStoreIdCartsPostRequestBodyContentApplicationJsonSchemaTaxTotal"},"EcommerceStoresCartsPatchAddress":{"type":"object","properties":{"address1":{"type":"string","description":"The mailing address of the customer."},"address2":{"type":"string","description":"An additional field for the customer's mailing address."},"city":{"type":"string","description":"The city the customer is located in."},"country":{"type":"string","description":"The customer's country."},"country_code":{"type":"string","description":"The two-letter code for the customer's country."},"postal_code":{"type":"string","description":"The customer's postal or zip code."},"province":{"type":"string","description":"The customer's state name or normalized province."},"province_code":{"type":"string","description":"The two-letter code for the customer's province or state."}},"description":"The customer's address.","title":"EcommerceStoresCartsPatchAddress"},"EcommerceStoresCartsPatchTotalSpent":{"oneOf":[{"type":"number","format":"double"},{"type":"string","pattern":"^\\s*[+-]?(?:[0-9]+\\.?[0-9]*|\\.[0-9]+)(?:[eE][+-]?[0-9]+)?\\s*$"}],"title":"EcommerceStoresCartsPatchTotalSpent"},"EcommerceStoresCartsPatch":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":50,"description":"A unique identifier for the customer. Limited to 50 characters."},"address":{"$ref":"#/components/schemas/EcommerceStoresCartsPatchAddress","description":"The customer's address."},"company":{"type":"string","description":"The customer's company."},"first_name":{"type":"string","description":"The customer's first name."},"last_name":{"type":"string","description":"The customer's last name."},"opt_in_status":{"type":"boolean","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)."},"total_spent":{"$ref":"#/components/schemas/EcommerceStoresCartsPatchTotalSpent"}},"description":"Information about a specific customer. Orders for existing customers should include only the `id` parameter in the `customer` object body.","title":"EcommerceStoresCartsPatch"},"30EcommerceStoresStoreIdCartsCartIdPatchRequestBodyContentApplicationJsonSchemaId":{"oneOf":[{"type":"string","pattern":"\\S","minLength":1},{"type":"integer"}],"description":"A unique identifier for the cart.","title":"30EcommerceStoresStoreIdCartsCartIdPatchRequestBodyContentApplicationJsonSchemaId"},"30EcommerceStoresStoreIdCartsCartIdPatchRequestBodyContentApplicationJsonSchemaLinesItemsPrice":{"oneOf":[{"type":"number","format":"double"},{"type":"string","pattern":"^\\s*[+-]?(?:[0-9]+\\.?[0-9]*|\\.[0-9]+)(?:[eE][+-]?[0-9]+)?\\s*$"}],"title":"30EcommerceStoresStoreIdCartsCartIdPatchRequestBodyContentApplicationJsonSchemaLinesItemsPrice"},"30EcommerceStoresStoreIdCartsCartIdPatchRequestBodyContentApplicationJsonSchemaLinesItems":{"type":"object","properties":{"price":{"$ref":"#/components/schemas/30EcommerceStoresStoreIdCartsCartIdPatchRequestBodyContentApplicationJsonSchemaLinesItemsPrice"},"product_id":{"type":"string","description":"A unique identifier for the product associated with the cart line item."},"product_variant_id":{"type":"string","description":"A unique identifier for the product variant associated with the cart line item."},"quantity":{"type":"integer","description":"The quantity of a cart line item."}},"description":"Information about a specific cart line item.","title":"30EcommerceStoresStoreIdCartsCartIdPatchRequestBodyContentApplicationJsonSchemaLinesItems"},"30EcommerceStoresStoreIdCartsCartIdPatchRequestBodyContentApplicationJsonSchemaOrderTotal":{"oneOf":[{"type":"number","format":"double"},{"type":"string","pattern":"^\\s*[+-]?(?:[0-9]+\\.?[0-9]*|\\.[0-9]+)(?:[eE][+-]?[0-9]+)?\\s*$"}],"title":"30EcommerceStoresStoreIdCartsCartIdPatchRequestBodyContentApplicationJsonSchemaOrderTotal"},"30EcommerceStoresStoreIdCartsCartIdPatchRequestBodyContentApplicationJsonSchemaTaxTotal":{"oneOf":[{"type":"number","format":"double"},{"type":"string","pattern":"^\\s*[+-]?(?:[0-9]+\\.?[0-9]*|\\.[0-9]+)(?:[eE][+-]?[0-9]+)?\\s*$"}],"title":"30EcommerceStoresStoreIdCartsCartIdPatchRequestBodyContentApplicationJsonSchemaTaxTotal"},"30EcommerceStoresStoreIdCartsCartIdLinesGetResponsesContentApplicationJsonSchemaLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"30EcommerceStoresStoreIdCartsCartIdLinesGetResponsesContentApplicationJsonSchemaLinksItemsMethod"},"30EcommerceStoresStoreIdCartsCartIdLinesGetResponsesContentApplicationJsonSchemaLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/30EcommerceStoresStoreIdCartsCartIdLinesGetResponsesContentApplicationJsonSchemaLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"30EcommerceStoresStoreIdCartsCartIdLinesGetResponsesContentApplicationJsonSchemaLinksItems"},"ecommerce_list-store-cart-lines_Response_200":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/30EcommerceStoresStoreIdCartsCartIdLinesGetResponsesContentApplicationJsonSchemaLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"cart_id":{"type":"string","description":"The cart id."},"lines":{"type":"array","items":{"$ref":"#/components/schemas/ECommerceCartLineItem"},"description":"An array of objects, each representing a cart's line item."},"store_id":{"type":"string","description":"The store id."},"total_items":{"type":"integer","description":"The total number of items matching the query regardless of pagination."}},"description":"A collection of a cart's line items.","title":"ecommerce_list-store-cart-lines_Response_200"},"30EcommerceStoresStoreIdCartsCartIdLinesPostRequestBodyContentApplicationJsonSchemaPrice":{"oneOf":[{"type":"number","format":"double"},{"type":"string","pattern":"^\\s*[+-]?(?:[0-9]+\\.?[0-9]*|\\.[0-9]+)(?:[eE][+-]?[0-9]+)?\\s*$"}],"title":"30EcommerceStoresStoreIdCartsCartIdLinesPostRequestBodyContentApplicationJsonSchemaPrice"},"30EcommerceStoresStoreIdCartsCartIdLinesLineIdPatchRequestBodyContentApplicationJsonSchemaPrice":{"oneOf":[{"type":"number","format":"double"},{"type":"string","pattern":"^\\s*[+-]?(?:[0-9]+\\.?[0-9]*|\\.[0-9]+)(?:[eE][+-]?[0-9]+)?\\s*$"}],"title":"30EcommerceStoresStoreIdCartsCartIdLinesLineIdPatchRequestBodyContentApplicationJsonSchemaPrice"},"30EcommerceStoresStoreIdCustomersGetResponsesContentApplicationJsonSchemaLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"30EcommerceStoresStoreIdCustomersGetResponsesContentApplicationJsonSchemaLinksItemsMethod"},"30EcommerceStoresStoreIdCustomersGetResponsesContentApplicationJsonSchemaLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/30EcommerceStoresStoreIdCustomersGetResponsesContentApplicationJsonSchemaLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"30EcommerceStoresStoreIdCustomersGetResponsesContentApplicationJsonSchemaLinksItems"},"ecommerce_list-store-customers_Response_200":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/30EcommerceStoresStoreIdCustomersGetResponsesContentApplicationJsonSchemaLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"customers":{"type":"array","items":{"$ref":"#/components/schemas/ECommerceCustomer"},"description":"An array of objects, each representing a customer of a store."},"store_id":{"type":"string","description":"The store id."},"total_items":{"type":"integer","description":"The total number of items matching the query regardless of pagination."}},"description":"A collection of the store's customers.","title":"ecommerce_list-store-customers_Response_200"},"30EcommerceStoresStoreIdCustomersPostRequestBodyContentApplicationJsonSchemaAddress":{"type":"object","properties":{"address1":{"type":"string","description":"The mailing address of the customer."},"address2":{"type":"string","description":"An additional field for the customer's mailing address."},"city":{"type":"string","description":"The city the customer is located in."},"country":{"type":"string","description":"The customer's country."},"country_code":{"type":"string","description":"The two-letter code for the customer's country."},"postal_code":{"type":"string","description":"The customer's postal or zip code."},"province":{"type":"string","description":"The customer's state name or normalized province."},"province_code":{"type":"string","description":"The two-letter code for the customer's province or state."}},"description":"The customer's address.","title":"30EcommerceStoresStoreIdCustomersPostRequestBodyContentApplicationJsonSchemaAddress"},"30EcommerceStoresStoreIdCustomersPostRequestBodyContentApplicationJsonSchemaTotalSpent":{"oneOf":[{"type":"number","format":"double"},{"type":"string","pattern":"^\\s*[+-]?(?:[0-9]+\\.?[0-9]*|\\.[0-9]+)(?:[eE][+-]?[0-9]+)?\\s*$"}],"title":"30EcommerceStoresStoreIdCustomersPostRequestBodyContentApplicationJsonSchemaTotalSpent"},"30EcommerceStoresStoreIdCustomersCustomerIdPutRequestBodyContentApplicationJsonSchemaAddress":{"type":"object","properties":{"address1":{"type":"string","description":"The mailing address of the customer."},"address2":{"type":"string","description":"An additional field for the customer's mailing address."},"city":{"type":"string","description":"The city the customer is located in."},"country":{"type":"string","description":"The customer's country."},"country_code":{"type":"string","description":"The two-letter code for the customer's country."},"postal_code":{"type":"string","description":"The customer's postal or zip code."},"province":{"type":"string","description":"The customer's state name or normalized province."},"province_code":{"type":"string","description":"The two-letter code for the customer's province or state."}},"description":"The customer's address.","title":"30EcommerceStoresStoreIdCustomersCustomerIdPutRequestBodyContentApplicationJsonSchemaAddress"},"30EcommerceStoresStoreIdCustomersCustomerIdPutRequestBodyContentApplicationJsonSchemaTotalSpent":{"oneOf":[{"type":"number","format":"double"},{"type":"string","pattern":"^\\s*[+-]?(?:[0-9]+\\.?[0-9]*|\\.[0-9]+)(?:[eE][+-]?[0-9]+)?\\s*$"}],"title":"30EcommerceStoresStoreIdCustomersCustomerIdPutRequestBodyContentApplicationJsonSchemaTotalSpent"},"30EcommerceStoresStoreIdOrdersGetResponsesContentApplicationJsonSchemaLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"30EcommerceStoresStoreIdOrdersGetResponsesContentApplicationJsonSchemaLinksItemsMethod"},"30EcommerceStoresStoreIdOrdersGetResponsesContentApplicationJsonSchemaLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/30EcommerceStoresStoreIdOrdersGetResponsesContentApplicationJsonSchemaLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"30EcommerceStoresStoreIdOrdersGetResponsesContentApplicationJsonSchemaLinksItems"},"ecommerce_list-store-orders_Response_200":{"type":"object","properties":{"store_id":{"type":"string","description":"The store id."},"orders":{"type":"array","items":{"$ref":"#/components/schemas/ECommerceOrder"},"description":"An array of objects, each representing an order in a store."},"total_items":{"type":"integer","description":"The total number of items matching the query regardless of pagination."},"_links":{"type":"array","items":{"$ref":"#/components/schemas/30EcommerceStoresStoreIdOrdersGetResponsesContentApplicationJsonSchemaLinksItems"},"description":"A list of link types and descriptions for the API schema documents."}},"description":"A collection of orders in a store.","title":"ecommerce_list-store-orders_Response_200"},"30EcommerceStoresStoreIdOrdersPostRequestBodyContentApplicationJsonSchemaBillingAddressLatitude":{"oneOf":[{"type":"number","format":"double"},{"type":"string","pattern":"^-?[0-9]+\\.?[0-9]*$"}],"description":"The latitude for the billing address location.","title":"30EcommerceStoresStoreIdOrdersPostRequestBodyContentApplicationJsonSchemaBillingAddressLatitude"},"30EcommerceStoresStoreIdOrdersPostRequestBodyContentApplicationJsonSchemaBillingAddressLongitude":{"oneOf":[{"type":"number","format":"double"},{"type":"string","pattern":"^-?[0-9]+\\.?[0-9]*$"}],"description":"The longitude for the billing address location.","title":"30EcommerceStoresStoreIdOrdersPostRequestBodyContentApplicationJsonSchemaBillingAddressLongitude"},"30EcommerceStoresStoreIdOrdersPostRequestBodyContentApplicationJsonSchemaBillingAddress":{"type":"object","properties":{"address1":{"type":"string","description":"The billing address for the order."},"address2":{"type":"string","description":"An additional field for the billing address."},"city":{"type":"string","description":"The city in the billing address."},"company":{"type":"string","description":"The company associated with the billing address."},"country":{"type":"string","description":"The country in the billing address."},"country_code":{"type":"string","description":"The two-letter code for the country in the billing address."},"latitude":{"$ref":"#/components/schemas/30EcommerceStoresStoreIdOrdersPostRequestBodyContentApplicationJsonSchemaBillingAddressLatitude","description":"The latitude for the billing address location."},"longitude":{"$ref":"#/components/schemas/30EcommerceStoresStoreIdOrdersPostRequestBodyContentApplicationJsonSchemaBillingAddressLongitude","description":"The longitude for the billing address location."},"name":{"type":"string","description":"The name associated with the billing address."},"phone":{"type":"string","description":"The phone number for the billing address"},"postal_code":{"type":"string","description":"The postal or zip code in the billing address."},"province":{"type":"string","description":"The state or normalized province in the billing address."},"province_code":{"type":"string","description":"The two-letter code for the province in the billing address."}},"description":"The billing address for the order.","title":"30EcommerceStoresStoreIdOrdersPostRequestBodyContentApplicationJsonSchemaBillingAddress"},"30EcommerceStoresStoreIdOrdersPostRequestBodyContentApplicationJsonSchemaCartId":{"oneOf":[{"type":"string"},{"type":"integer"}],"description":"A cart id that the order was placed for.","title":"30EcommerceStoresStoreIdOrdersPostRequestBodyContentApplicationJsonSchemaCartId"},"30EcommerceStoresStoreIdOrdersPostRequestBodyContentApplicationJsonSchemaDiscountTotal":{"oneOf":[{"type":"number","format":"double"},{"type":"string","pattern":"^\\s*[+-]?(?:[0-9]+\\.?[0-9]*|\\.[0-9]+)(?:[eE][+-]?[0-9]+)?\\s*$"}],"title":"30EcommerceStoresStoreIdOrdersPostRequestBodyContentApplicationJsonSchemaDiscountTotal"},"30EcommerceStoresStoreIdOrdersPostRequestBodyContentApplicationJsonSchemaLinesItemsDiscount":{"oneOf":[{"type":"number","format":"double"},{"type":"string","pattern":"^\\s*[+-]?(?:[0-9]+\\.?[0-9]*|\\.[0-9]+)(?:[eE][+-]?[0-9]+)?\\s*$"}],"title":"30EcommerceStoresStoreIdOrdersPostRequestBodyContentApplicationJsonSchemaLinesItemsDiscount"},"30EcommerceStoresStoreIdOrdersPostRequestBodyContentApplicationJsonSchemaLinesItemsPrice":{"oneOf":[{"type":"number","format":"double"},{"type":"string","pattern":"^\\s*[+-]?(?:[0-9]+\\.?[0-9]*|\\.[0-9]+)(?:[eE][+-]?[0-9]+)?\\s*$"}],"title":"30EcommerceStoresStoreIdOrdersPostRequestBodyContentApplicationJsonSchemaLinesItemsPrice"},"EcommerceStoresOrdersPostId":{"oneOf":[{"type":"string","pattern":"\\S","minLength":1},{"type":"integer"}],"description":"A unique identifier for the product.","title":"EcommerceStoresOrdersPostId"},"EcommerceStoresOrdersPostImagesItemsVariantIdsItems":{"oneOf":[{"type":"string"},{"type":"integer"}],"title":"EcommerceStoresOrdersPostImagesItemsVariantIdsItems"},"EcommerceStoresOrdersPostImagesItems":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":50,"description":"A unique identifier for the product image."},"url":{"type":"string","description":"The URL for a product image."},"variant_ids":{"type":"array","items":{"$ref":"#/components/schemas/EcommerceStoresOrdersPostImagesItemsVariantIdsItems"},"description":"The list of product variants using the image."}},"required":["id","url"],"description":"Information about a specific product image.","title":"EcommerceStoresOrdersPostImagesItems"},"EcommerceStoresOrdersPostVariantsItemsId":{"oneOf":[{"type":"string","minLength":1},{"type":"integer"}],"description":"A unique identifier for the product variant.","title":"EcommerceStoresOrdersPostVariantsItemsId"},"EcommerceStoresOrdersPostVariantsItemsPrice":{"oneOf":[{"type":"number","format":"double"},{"type":"string","pattern":"^\\s*[+-]?(?:[0-9]+\\.?[0-9]*|\\.[0-9]+)(?:[eE][+-]?[0-9]+)?\\s*$"}],"title":"EcommerceStoresOrdersPostVariantsItemsPrice"},"EcommerceStoresOrdersPostVariantsItems":{"type":"object","properties":{"backorders":{"type":"string","description":"The backorders of a product variant."},"id":{"$ref":"#/components/schemas/EcommerceStoresOrdersPostVariantsItemsId","description":"A unique identifier for the product variant."},"image_url":{"type":"string","description":"The image URL for a product variant."},"inventory_quantity":{"type":"integer","description":"The inventory quantity of a product variant."},"price":{"$ref":"#/components/schemas/EcommerceStoresOrdersPostVariantsItemsPrice"},"sku":{"type":"string","description":"The stock keeping unit (SKU) of a product variant."},"title":{"type":"string","pattern":"\\S","minLength":1,"description":"The title of a product variant."},"url":{"type":"string","description":"The URL for a product variant."},"visibility":{"type":"string","description":"The visibility of a product variant."}},"required":["id","title"],"description":"Information about a specific product variant.","title":"EcommerceStoresOrdersPostVariantsItems"},"EcommerceStoresOrdersPost":{"type":"object","properties":{"description":{"type":"string","description":"The description of a product."},"handle":{"type":"string","description":"The handle of a product."},"id":{"$ref":"#/components/schemas/EcommerceStoresOrdersPostId","description":"A unique identifier for the product."},"image_url":{"type":"string","description":"The image URL for a product."},"images":{"type":"array","items":{"$ref":"#/components/schemas/EcommerceStoresOrdersPostImagesItems"},"description":"An array of the product's images."},"published_at_foreign":{"type":"string","description":"The date and time the product was published."},"title":{"type":"string","pattern":"\\S","minLength":1,"description":"The title of a product."},"type":{"type":"string","description":"The type of product."},"url":{"type":"string","description":"The URL for a product."},"variants":{"type":"array","items":{"$ref":"#/components/schemas/EcommerceStoresOrdersPostVariantsItems"},"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."},"vendor":{"type":"string","description":"The vendor for a product."}},"required":["id","title","variants"],"description":"Information about a specific product.","title":"EcommerceStoresOrdersPost"},"30EcommerceStoresStoreIdOrdersPostRequestBodyContentApplicationJsonSchemaLinesItems":{"type":"object","properties":{"discount":{"$ref":"#/components/schemas/30EcommerceStoresStoreIdOrdersPostRequestBodyContentApplicationJsonSchemaLinesItemsDiscount"},"id":{"type":"string","minLength":1,"description":"A unique identifier for the order line item."},"price":{"$ref":"#/components/schemas/30EcommerceStoresStoreIdOrdersPostRequestBodyContentApplicationJsonSchemaLinesItemsPrice"},"product":{"$ref":"#/components/schemas/EcommerceStoresOrdersPost"},"product_id":{"type":"string","description":"A unique identifier for the product associated with the order line item."},"product_variant_id":{"type":"string","description":"A unique identifier for the product variant associated with the order line item."},"quantity":{"type":"integer","description":"The quantity of an order line item."}},"required":["id","price","product_id","product_variant_id","quantity"],"description":"Information about a specific order line.","title":"30EcommerceStoresStoreIdOrdersPostRequestBodyContentApplicationJsonSchemaLinesItems"},"30EcommerceStoresStoreIdOrdersPostRequestBodyContentApplicationJsonSchemaOrderTotal":{"oneOf":[{"type":"number","format":"double"},{"type":"string","pattern":"^\\s*[+-]?(?:[0-9]+\\.?[0-9]*|\\.[0-9]+)(?:[eE][+-]?[0-9]+)?\\s*$"}],"title":"30EcommerceStoresStoreIdOrdersPostRequestBodyContentApplicationJsonSchemaOrderTotal"},"30EcommerceStoresStoreIdOrdersPostRequestBodyContentApplicationJsonSchemaOutreach":{"type":"object","properties":{"id":{"type":"string","description":"A unique identifier for the outreach. Can be an email campaign ID."}},"description":"The outreach associated with this order. For example, an email campaign or Facebook ad.","title":"30EcommerceStoresStoreIdOrdersPostRequestBodyContentApplicationJsonSchemaOutreach"},"30EcommerceStoresStoreIdOrdersPostRequestBodyContentApplicationJsonSchemaPromosItemsAmountDiscounted":{"oneOf":[{"type":"number","format":"double"},{"type":"string","pattern":"^\\s*[+-]?(?:[0-9]+\\.?[0-9]*|\\.[0-9]+)(?:[eE][+-]?[0-9]+)?\\s*$"}],"title":"30EcommerceStoresStoreIdOrdersPostRequestBodyContentApplicationJsonSchemaPromosItemsAmountDiscounted"},"30EcommerceStoresStoreIdOrdersPostRequestBodyContentApplicationJsonSchemaPromosItemsType":{"type":"string","enum":["fixed","percentage"],"description":"Type of discount. For free shipping set type to fixed","title":"30EcommerceStoresStoreIdOrdersPostRequestBodyContentApplicationJsonSchemaPromosItemsType"},"30EcommerceStoresStoreIdOrdersPostRequestBodyContentApplicationJsonSchemaPromosItems":{"type":"object","properties":{"amount_discounted":{"$ref":"#/components/schemas/30EcommerceStoresStoreIdOrdersPostRequestBodyContentApplicationJsonSchemaPromosItemsAmountDiscounted"},"code":{"type":"string","description":"The Promo Code"},"type":{"$ref":"#/components/schemas/30EcommerceStoresStoreIdOrdersPostRequestBodyContentApplicationJsonSchemaPromosItemsType","description":"Type of discount. For free shipping set type to fixed"}},"required":["amount_discounted","code","type"],"title":"30EcommerceStoresStoreIdOrdersPostRequestBodyContentApplicationJsonSchemaPromosItems"},"30EcommerceStoresStoreIdOrdersPostRequestBodyContentApplicationJsonSchemaShippingAddressLatitude":{"oneOf":[{"type":"number","format":"double"},{"type":"string","pattern":"^-?[0-9]+\\.?[0-9]*$"}],"description":"The latitude for the shipping address location.","title":"30EcommerceStoresStoreIdOrdersPostRequestBodyContentApplicationJsonSchemaShippingAddressLatitude"},"30EcommerceStoresStoreIdOrdersPostRequestBodyContentApplicationJsonSchemaShippingAddressLongitude":{"oneOf":[{"type":"number","format":"double"},{"type":"string","pattern":"^-?[0-9]+\\.?[0-9]*$"}],"description":"The longitude for the shipping address location.","title":"30EcommerceStoresStoreIdOrdersPostRequestBodyContentApplicationJsonSchemaShippingAddressLongitude"},"30EcommerceStoresStoreIdOrdersPostRequestBodyContentApplicationJsonSchemaShippingAddress":{"type":"object","properties":{"address1":{"type":"string","description":"The shipping address for the order."},"address2":{"type":"string","description":"An additional field for the shipping address."},"city":{"type":"string","description":"The city in the order's shipping address."},"company":{"type":"string","description":"The company associated with the shipping address."},"country":{"type":"string","description":"The country in the shipping address."},"country_code":{"type":"string","description":"The two-letter code for the country in the shipping address."},"latitude":{"$ref":"#/components/schemas/30EcommerceStoresStoreIdOrdersPostRequestBodyContentApplicationJsonSchemaShippingAddressLatitude","description":"The latitude for the shipping address location."},"longitude":{"$ref":"#/components/schemas/30EcommerceStoresStoreIdOrdersPostRequestBodyContentApplicationJsonSchemaShippingAddressLongitude","description":"The longitude for the shipping address location."},"name":{"type":"string","description":"The name associated with an order's shipping address."},"phone":{"type":"string","description":"The phone number for the order's shipping address."},"postal_code":{"type":"string","description":"The postal or zip code in the shipping address."},"province":{"type":"string","description":"The state or normalized province in the order's shipping address."},"province_code":{"type":"string","description":"The two-letter code for the province or state in the shipping address."}},"description":"The shipping address for the order.","title":"30EcommerceStoresStoreIdOrdersPostRequestBodyContentApplicationJsonSchemaShippingAddress"},"30EcommerceStoresStoreIdOrdersPostRequestBodyContentApplicationJsonSchemaShippingTotal":{"oneOf":[{"type":"number","format":"double"},{"type":"string","pattern":"^\\s*[+-]?(?:[0-9]+\\.?[0-9]*|\\.[0-9]+)(?:[eE][+-]?[0-9]+)?\\s*$"}],"title":"30EcommerceStoresStoreIdOrdersPostRequestBodyContentApplicationJsonSchemaShippingTotal"},"30EcommerceStoresStoreIdOrdersPostRequestBodyContentApplicationJsonSchemaTaxTotal":{"oneOf":[{"type":"number","format":"double"},{"type":"string","pattern":"^\\s*[+-]?(?:[0-9]+\\.?[0-9]*|\\.[0-9]+)(?:[eE][+-]?[0-9]+)?\\s*$"}],"title":"30EcommerceStoresStoreIdOrdersPostRequestBodyContentApplicationJsonSchemaTaxTotal"},"30EcommerceStoresStoreIdOrdersPostRequestBodyContentApplicationJsonSchemaTrackingCode":{"type":"string","enum":["prec"],"description":"The Mailchimp tracking code for the order. Uses the 'mc_tc' parameter in E-Commerce tracking URLs.","title":"30EcommerceStoresStoreIdOrdersPostRequestBodyContentApplicationJsonSchemaTrackingCode"},"30EcommerceStoresStoreIdOrdersOrderIdPatchRequestBodyContentApplicationJsonSchemaBillingAddressLatitude":{"oneOf":[{"type":"number","format":"double"},{"type":"string","pattern":"^-?[0-9]+\\.?[0-9]*$"}],"description":"The latitude for the billing address location.","title":"30EcommerceStoresStoreIdOrdersOrderIdPatchRequestBodyContentApplicationJsonSchemaBillingAddressLatitude"},"30EcommerceStoresStoreIdOrdersOrderIdPatchRequestBodyContentApplicationJsonSchemaBillingAddressLongitude":{"oneOf":[{"type":"number","format":"double"},{"type":"string","pattern":"^-?[0-9]+\\.?[0-9]*$"}],"description":"The longitude for the billing address location.","title":"30EcommerceStoresStoreIdOrdersOrderIdPatchRequestBodyContentApplicationJsonSchemaBillingAddressLongitude"},"30EcommerceStoresStoreIdOrdersOrderIdPatchRequestBodyContentApplicationJsonSchemaBillingAddress":{"type":"object","properties":{"address1":{"type":"string","description":"The billing address for the order."},"address2":{"type":"string","description":"An additional field for the billing address."},"city":{"type":"string","description":"The city in the billing address."},"company":{"type":"string","description":"The company associated with the billing address."},"country":{"type":"string","description":"The country in the billing address."},"country_code":{"type":"string","description":"The two-letter code for the country in the billing address."},"latitude":{"$ref":"#/components/schemas/30EcommerceStoresStoreIdOrdersOrderIdPatchRequestBodyContentApplicationJsonSchemaBillingAddressLatitude","description":"The latitude for the billing address location."},"longitude":{"$ref":"#/components/schemas/30EcommerceStoresStoreIdOrdersOrderIdPatchRequestBodyContentApplicationJsonSchemaBillingAddressLongitude","description":"The longitude for the billing address location."},"name":{"type":"string","description":"The name associated with an order's billing address."},"phone":{"type":"string","description":"The phone number for the billing address."},"postal_code":{"type":"string","description":"The postal or zip code in the billing address."},"province":{"type":"string","description":"The state or normalized province in the billing address."},"province_code":{"type":"string","description":"The two-letter code for the province or state in the billing address."}},"description":"The billing address for the order.","title":"30EcommerceStoresStoreIdOrdersOrderIdPatchRequestBodyContentApplicationJsonSchemaBillingAddress"},"30EcommerceStoresStoreIdOrdersOrderIdPatchRequestBodyContentApplicationJsonSchemaCartId":{"oneOf":[{"type":"string"},{"type":"integer"}],"description":"A cart id that the order was placed for.","title":"30EcommerceStoresStoreIdOrdersOrderIdPatchRequestBodyContentApplicationJsonSchemaCartId"},"30EcommerceStoresStoreIdOrdersOrderIdPatchRequestBodyContentApplicationJsonSchemaDiscountTotal":{"oneOf":[{"type":"number","format":"double"},{"type":"string","pattern":"^\\s*[+-]?(?:[0-9]+\\.?[0-9]*|\\.[0-9]+)(?:[eE][+-]?[0-9]+)?\\s*$"}],"title":"30EcommerceStoresStoreIdOrdersOrderIdPatchRequestBodyContentApplicationJsonSchemaDiscountTotal"},"30EcommerceStoresStoreIdOrdersOrderIdPatchRequestBodyContentApplicationJsonSchemaLinesItemsDiscount":{"oneOf":[{"type":"number","format":"double"},{"type":"string","pattern":"^\\s*[+-]?(?:[0-9]+\\.?[0-9]*|\\.[0-9]+)(?:[eE][+-]?[0-9]+)?\\s*$"}],"title":"30EcommerceStoresStoreIdOrdersOrderIdPatchRequestBodyContentApplicationJsonSchemaLinesItemsDiscount"},"30EcommerceStoresStoreIdOrdersOrderIdPatchRequestBodyContentApplicationJsonSchemaLinesItemsPrice":{"oneOf":[{"type":"number","format":"double"},{"type":"string","pattern":"^\\s*[+-]?(?:[0-9]+\\.?[0-9]*|\\.[0-9]+)(?:[eE][+-]?[0-9]+)?\\s*$"}],"title":"30EcommerceStoresStoreIdOrdersOrderIdPatchRequestBodyContentApplicationJsonSchemaLinesItemsPrice"},"30EcommerceStoresStoreIdOrdersOrderIdPatchRequestBodyContentApplicationJsonSchemaLinesItems":{"type":"object","properties":{"discount":{"$ref":"#/components/schemas/30EcommerceStoresStoreIdOrdersOrderIdPatchRequestBodyContentApplicationJsonSchemaLinesItemsDiscount"},"id":{"type":"string","minLength":1,"description":"A unique identifier for the order line item."},"price":{"$ref":"#/components/schemas/30EcommerceStoresStoreIdOrdersOrderIdPatchRequestBodyContentApplicationJsonSchemaLinesItemsPrice"},"product_id":{"type":"string","description":"A unique identifier for the product associated with the order line item."},"product_variant_id":{"type":"string","description":"A unique identifier for the product variant associated with the order line item."},"quantity":{"type":"integer","description":"The quantity of an order line item."}},"description":"Information about a specific order line.","title":"30EcommerceStoresStoreIdOrdersOrderIdPatchRequestBodyContentApplicationJsonSchemaLinesItems"},"30EcommerceStoresStoreIdOrdersOrderIdPatchRequestBodyContentApplicationJsonSchemaOrderTotal":{"oneOf":[{"type":"number","format":"double"},{"type":"string","pattern":"^\\s*[+-]?(?:[0-9]+\\.?[0-9]*|\\.[0-9]+)(?:[eE][+-]?[0-9]+)?\\s*$"}],"title":"30EcommerceStoresStoreIdOrdersOrderIdPatchRequestBodyContentApplicationJsonSchemaOrderTotal"},"30EcommerceStoresStoreIdOrdersOrderIdPatchRequestBodyContentApplicationJsonSchemaOutreach":{"type":"object","properties":{"id":{"type":"string","description":"A unique identifier for the outreach. Can be an email campaign ID."}},"description":"The outreach associated with this order. For example, an email campaign or Facebook ad.","title":"30EcommerceStoresStoreIdOrdersOrderIdPatchRequestBodyContentApplicationJsonSchemaOutreach"},"30EcommerceStoresStoreIdOrdersOrderIdPatchRequestBodyContentApplicationJsonSchemaPromosItemsAmountDiscounted":{"oneOf":[{"type":"number","format":"double"},{"type":"string","pattern":"^\\s*[+-]?(?:[0-9]+\\.?[0-9]*|\\.[0-9]+)(?:[eE][+-]?[0-9]+)?\\s*$"}],"title":"30EcommerceStoresStoreIdOrdersOrderIdPatchRequestBodyContentApplicationJsonSchemaPromosItemsAmountDiscounted"},"30EcommerceStoresStoreIdOrdersOrderIdPatchRequestBodyContentApplicationJsonSchemaPromosItemsType":{"type":"string","enum":["fixed","percentage"],"description":"Type of discount. For free shipping set type to fixed","title":"30EcommerceStoresStoreIdOrdersOrderIdPatchRequestBodyContentApplicationJsonSchemaPromosItemsType"},"30EcommerceStoresStoreIdOrdersOrderIdPatchRequestBodyContentApplicationJsonSchemaPromosItems":{"type":"object","properties":{"amount_discounted":{"$ref":"#/components/schemas/30EcommerceStoresStoreIdOrdersOrderIdPatchRequestBodyContentApplicationJsonSchemaPromosItemsAmountDiscounted"},"code":{"type":"string","description":"The Promo Code"},"type":{"$ref":"#/components/schemas/30EcommerceStoresStoreIdOrdersOrderIdPatchRequestBodyContentApplicationJsonSchemaPromosItemsType","description":"Type of discount. For free shipping set type to fixed"}},"required":["amount_discounted","code","type"],"title":"30EcommerceStoresStoreIdOrdersOrderIdPatchRequestBodyContentApplicationJsonSchemaPromosItems"},"30EcommerceStoresStoreIdOrdersOrderIdPatchRequestBodyContentApplicationJsonSchemaShippingAddressLatitude":{"oneOf":[{"type":"number","format":"double"},{"type":"string","pattern":"^-?[0-9]+\\.?[0-9]*$"}],"description":"The latitude for the shipping address location.","title":"30EcommerceStoresStoreIdOrdersOrderIdPatchRequestBodyContentApplicationJsonSchemaShippingAddressLatitude"},"30EcommerceStoresStoreIdOrdersOrderIdPatchRequestBodyContentApplicationJsonSchemaShippingAddressLongitude":{"oneOf":[{"type":"number","format":"double"},{"type":"string","pattern":"^-?[0-9]+\\.?[0-9]*$"}],"description":"The longitude for the shipping address location.","title":"30EcommerceStoresStoreIdOrdersOrderIdPatchRequestBodyContentApplicationJsonSchemaShippingAddressLongitude"},"30EcommerceStoresStoreIdOrdersOrderIdPatchRequestBodyContentApplicationJsonSchemaShippingAddress":{"type":"object","properties":{"address1":{"type":"string","description":"The shipping address for the order."},"address2":{"type":"string","description":"An additional field for the shipping address."},"city":{"type":"string","description":"The city in the order's shipping address."},"company":{"type":"string","description":"The company associated with an order's shipping address."},"country":{"type":"string","description":"The country in the order's shipping address."},"country_code":{"type":"string","description":"The two-letter code for the country in the shipping address."},"latitude":{"$ref":"#/components/schemas/30EcommerceStoresStoreIdOrdersOrderIdPatchRequestBodyContentApplicationJsonSchemaShippingAddressLatitude","description":"The latitude for the shipping address location."},"longitude":{"$ref":"#/components/schemas/30EcommerceStoresStoreIdOrdersOrderIdPatchRequestBodyContentApplicationJsonSchemaShippingAddressLongitude","description":"The longitude for the shipping address location."},"name":{"type":"string","description":"The name associated with an order's shipping address."},"phone":{"type":"string","description":"The phone number for the order's shipping address"},"postal_code":{"type":"string","description":"The postal or zip code in the order's shipping address."},"province":{"type":"string","description":"The state or normalized province in the order's shipping address."},"province_code":{"type":"string","description":"The two-letter code for the province or state the order's shipping address is located in."}},"description":"The shipping address for the order.","title":"30EcommerceStoresStoreIdOrdersOrderIdPatchRequestBodyContentApplicationJsonSchemaShippingAddress"},"30EcommerceStoresStoreIdOrdersOrderIdPatchRequestBodyContentApplicationJsonSchemaShippingTotal":{"oneOf":[{"type":"number","format":"double"},{"type":"string","pattern":"^\\s*[+-]?(?:[0-9]+\\.?[0-9]*|\\.[0-9]+)(?:[eE][+-]?[0-9]+)?\\s*$"}],"title":"30EcommerceStoresStoreIdOrdersOrderIdPatchRequestBodyContentApplicationJsonSchemaShippingTotal"},"30EcommerceStoresStoreIdOrdersOrderIdPatchRequestBodyContentApplicationJsonSchemaTaxTotal":{"oneOf":[{"type":"number","format":"double"},{"type":"string","pattern":"^\\s*[+-]?(?:[0-9]+\\.?[0-9]*|\\.[0-9]+)(?:[eE][+-]?[0-9]+)?\\s*$"}],"title":"30EcommerceStoresStoreIdOrdersOrderIdPatchRequestBodyContentApplicationJsonSchemaTaxTotal"},"30EcommerceStoresStoreIdOrdersOrderIdPatchRequestBodyContentApplicationJsonSchemaTrackingCode":{"type":"string","enum":["prec"],"description":"The Mailchimp tracking code for the order. Uses the 'mc_tc' parameter in E-Commerce tracking URLs.","title":"30EcommerceStoresStoreIdOrdersOrderIdPatchRequestBodyContentApplicationJsonSchemaTrackingCode"},"30EcommerceStoresStoreIdOrdersOrderIdLinesGetResponsesContentApplicationJsonSchemaLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"30EcommerceStoresStoreIdOrdersOrderIdLinesGetResponsesContentApplicationJsonSchemaLinksItemsMethod"},"30EcommerceStoresStoreIdOrdersOrderIdLinesGetResponsesContentApplicationJsonSchemaLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/30EcommerceStoresStoreIdOrdersOrderIdLinesGetResponsesContentApplicationJsonSchemaLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"30EcommerceStoresStoreIdOrdersOrderIdLinesGetResponsesContentApplicationJsonSchemaLinksItems"},"ecommerce_list-store-order-lines_Response_200":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/30EcommerceStoresStoreIdOrdersOrderIdLinesGetResponsesContentApplicationJsonSchemaLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"lines":{"type":"array","items":{"$ref":"#/components/schemas/ECommerceOrderLineItem"},"description":"An array of objects, each representing an order's line item."},"order_id":{"type":"string","description":"The order id."},"store_id":{"type":"string","description":"The store id."},"total_items":{"type":"integer","description":"The total number of items matching the query regardless of pagination."}},"description":"A collection of an order's line items.","title":"ecommerce_list-store-order-lines_Response_200"},"30EcommerceStoresStoreIdOrdersOrderIdLinesPostRequestBodyContentApplicationJsonSchemaDiscount":{"oneOf":[{"type":"number","format":"double"},{"type":"string","pattern":"^\\s*[+-]?(?:[0-9]+\\.?[0-9]*|\\.[0-9]+)(?:[eE][+-]?[0-9]+)?\\s*$"}],"title":"30EcommerceStoresStoreIdOrdersOrderIdLinesPostRequestBodyContentApplicationJsonSchemaDiscount"},"30EcommerceStoresStoreIdOrdersOrderIdLinesPostRequestBodyContentApplicationJsonSchemaPrice":{"oneOf":[{"type":"number","format":"double"},{"type":"string","pattern":"^\\s*[+-]?(?:[0-9]+\\.?[0-9]*|\\.[0-9]+)(?:[eE][+-]?[0-9]+)?\\s*$"}],"title":"30EcommerceStoresStoreIdOrdersOrderIdLinesPostRequestBodyContentApplicationJsonSchemaPrice"},"30EcommerceStoresStoreIdOrdersOrderIdLinesLineIdPatchRequestBodyContentApplicationJsonSchemaDiscount":{"oneOf":[{"type":"number","format":"double"},{"type":"string","pattern":"^\\s*[+-]?(?:[0-9]+\\.?[0-9]*|\\.[0-9]+)(?:[eE][+-]?[0-9]+)?\\s*$"}],"title":"30EcommerceStoresStoreIdOrdersOrderIdLinesLineIdPatchRequestBodyContentApplicationJsonSchemaDiscount"},"30EcommerceStoresStoreIdOrdersOrderIdLinesLineIdPatchRequestBodyContentApplicationJsonSchemaPrice":{"oneOf":[{"type":"number","format":"double"},{"type":"string","pattern":"^\\s*[+-]?(?:[0-9]+\\.?[0-9]*|\\.[0-9]+)(?:[eE][+-]?[0-9]+)?\\s*$"}],"title":"30EcommerceStoresStoreIdOrdersOrderIdLinesLineIdPatchRequestBodyContentApplicationJsonSchemaPrice"},"30EcommerceStoresStoreIdProductsGetResponsesContentApplicationJsonSchemaLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"30EcommerceStoresStoreIdProductsGetResponsesContentApplicationJsonSchemaLinksItemsMethod"},"30EcommerceStoresStoreIdProductsGetResponsesContentApplicationJsonSchemaLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/30EcommerceStoresStoreIdProductsGetResponsesContentApplicationJsonSchemaLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"30EcommerceStoresStoreIdProductsGetResponsesContentApplicationJsonSchemaLinksItems"},"ECommerceProductLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"ECommerceProductLinksItemsMethod"},"ECommerceProductLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/ECommerceProductLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"ECommerceProductLinksItems"},"ECommerceProductImagesItemsLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"ECommerceProductImagesItemsLinksItemsMethod"},"ECommerceProductImagesItemsLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/ECommerceProductImagesItemsLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"ECommerceProductImagesItemsLinksItems"},"ECommerceProductImagesItems":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/ECommerceProductImagesItemsLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"id":{"type":"string","description":"A unique identifier for the product image."},"url":{"type":"string","description":"The URL for a product image."},"variant_ids":{"type":"array","items":{"type":"string"},"description":"The list of product variants using the image."}},"description":"Information about a specific product image.","title":"ECommerceProductImagesItems"},"ECommerceProductVariantLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"ECommerceProductVariantLinksItemsMethod"},"ECommerceProductVariantLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/ECommerceProductVariantLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"ECommerceProductVariantLinksItems"},"ECommerceProductVariant":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/ECommerceProductVariantLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"backorders":{"type":"string","description":"The backorders of a product variant."},"created_at":{"type":"string","format":"date-time","description":"The date and time the product was created in ISO 8601 format."},"id":{"type":"string","description":"A unique identifier for the product variant."},"image_url":{"type":"string","description":"The image URL for a product variant."},"inventory_quantity":{"type":"integer","description":"The inventory quantity of a product variant."},"price":{"type":"number","format":"double","description":"The price of a product variant."},"sku":{"type":"string","description":"The stock keeping unit (SKU) of a product variant."},"title":{"type":"string","description":"The title of a product variant."},"updated_at":{"type":"string","format":"date-time","description":"The date and time the product was last updated in ISO 8601 format."},"url":{"type":"string","description":"The URL for a product variant."},"visibility":{"type":"string","description":"The visibility of a product variant."}},"description":"Information about a specific product variant.","title":"ECommerceProductVariant"},"ECommerceProduct":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/ECommerceProductLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"currency_code":{"type":"string","description":"The currency code"},"description":{"type":"string","description":"The description of a product."},"handle":{"type":"string","description":"The handle of a product."},"id":{"type":"string","description":"A unique identifier for the product."},"image_url":{"type":"string","description":"The image URL for a product."},"images":{"type":"array","items":{"$ref":"#/components/schemas/ECommerceProductImagesItems"},"description":"An array of the product's images."},"published_at_foreign":{"type":"string","format":"date-time","description":"The date and time the product was published in ISO 8601 format."},"title":{"type":"string","description":"The title of a product."},"type":{"type":"string","description":"The type of product."},"url":{"type":"string","description":"The URL for a product."},"variants":{"type":"array","items":{"$ref":"#/components/schemas/ECommerceProductVariant"},"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/)."},"vendor":{"type":"string","description":"The vendor for a product."}},"description":"Information about a specific product.","title":"ECommerceProduct"},"ecommerce_list-store-products_Response_200":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/30EcommerceStoresStoreIdProductsGetResponsesContentApplicationJsonSchemaLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"products":{"type":"array","items":{"$ref":"#/components/schemas/ECommerceProduct"},"description":"An array of objects, each representing a store product."},"store_id":{"type":"string","description":"The store id."},"total_items":{"type":"integer","description":"The total number of items matching the query regardless of pagination."}},"description":"A collection of a store's products.","title":"ecommerce_list-store-products_Response_200"},"30EcommerceStoresStoreIdProductsProductIdPatchRequestBodyContentApplicationJsonSchemaId":{"oneOf":[{"type":"string","pattern":"\\S","minLength":1},{"type":"integer"}],"description":"A unique identifier for the product.","title":"30EcommerceStoresStoreIdProductsProductIdPatchRequestBodyContentApplicationJsonSchemaId"},"30EcommerceStoresStoreIdProductsProductIdPatchRequestBodyContentApplicationJsonSchemaImagesItemsVariantIdsItems":{"oneOf":[{"type":"string"},{"type":"integer"}],"title":"30EcommerceStoresStoreIdProductsProductIdPatchRequestBodyContentApplicationJsonSchemaImagesItemsVariantIdsItems"},"30EcommerceStoresStoreIdProductsProductIdPatchRequestBodyContentApplicationJsonSchemaImagesItems":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":50,"description":"A unique identifier for the product image."},"url":{"type":"string","description":"The URL for a product image."},"variant_ids":{"type":"array","items":{"$ref":"#/components/schemas/30EcommerceStoresStoreIdProductsProductIdPatchRequestBodyContentApplicationJsonSchemaImagesItemsVariantIdsItems"},"description":"The list of product variants using the image."}},"description":"Information about a specific product image.","title":"30EcommerceStoresStoreIdProductsProductIdPatchRequestBodyContentApplicationJsonSchemaImagesItems"},"30EcommerceStoresStoreIdProductsProductIdPatchRequestBodyContentApplicationJsonSchemaVariantsItemsPrice":{"oneOf":[{"type":"number","format":"double"},{"type":"string","pattern":"^\\s*[+-]?(?:[0-9]+\\.?[0-9]*|\\.[0-9]+)(?:[eE][+-]?[0-9]+)?\\s*$"}],"title":"30EcommerceStoresStoreIdProductsProductIdPatchRequestBodyContentApplicationJsonSchemaVariantsItemsPrice"},"30EcommerceStoresStoreIdProductsProductIdPatchRequestBodyContentApplicationJsonSchemaVariantsItems":{"type":"object","properties":{"backorders":{"type":"string","description":"The backorders of a product variant."},"image_url":{"type":"string","description":"The image URL for a product variant."},"inventory_quantity":{"type":"integer","description":"The inventory quantity of a product variant."},"price":{"$ref":"#/components/schemas/30EcommerceStoresStoreIdProductsProductIdPatchRequestBodyContentApplicationJsonSchemaVariantsItemsPrice"},"sku":{"type":"string","description":"The stock keeping unit (SKU) of a product variant."},"title":{"type":"string","pattern":"\\S","minLength":1,"description":"The title of a product variant."},"url":{"type":"string","description":"The URL for a product variant."},"visibility":{"type":"string","description":"The visibility of a product variant."}},"description":"Information about a specific product variant.","title":"30EcommerceStoresStoreIdProductsProductIdPatchRequestBodyContentApplicationJsonSchemaVariantsItems"},"30EcommerceStoresStoreIdProductsProductIdPutRequestBodyContentApplicationJsonSchemaId":{"oneOf":[{"type":"string","pattern":"\\S","minLength":1},{"type":"integer"}],"description":"A unique identifier for the product.","title":"30EcommerceStoresStoreIdProductsProductIdPutRequestBodyContentApplicationJsonSchemaId"},"30EcommerceStoresStoreIdProductsProductIdPutRequestBodyContentApplicationJsonSchemaImagesItemsVariantIdsItems":{"oneOf":[{"type":"string"},{"type":"integer"}],"title":"30EcommerceStoresStoreIdProductsProductIdPutRequestBodyContentApplicationJsonSchemaImagesItemsVariantIdsItems"},"30EcommerceStoresStoreIdProductsProductIdPutRequestBodyContentApplicationJsonSchemaImagesItems":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":50,"description":"A unique identifier for the product image."},"url":{"type":"string","description":"The URL for a product image."},"variant_ids":{"type":"array","items":{"$ref":"#/components/schemas/30EcommerceStoresStoreIdProductsProductIdPutRequestBodyContentApplicationJsonSchemaImagesItemsVariantIdsItems"},"description":"The list of product variants using the image."}},"required":["id","url"],"description":"Information about a specific product image.","title":"30EcommerceStoresStoreIdProductsProductIdPutRequestBodyContentApplicationJsonSchemaImagesItems"},"30EcommerceStoresStoreIdProductsProductIdPutRequestBodyContentApplicationJsonSchemaVariantsItemsId":{"oneOf":[{"type":"string","minLength":1},{"type":"integer"}],"description":"A unique identifier for the product variant.","title":"30EcommerceStoresStoreIdProductsProductIdPutRequestBodyContentApplicationJsonSchemaVariantsItemsId"},"30EcommerceStoresStoreIdProductsProductIdPutRequestBodyContentApplicationJsonSchemaVariantsItemsPrice":{"oneOf":[{"type":"number","format":"double"},{"type":"string","pattern":"^\\s*[+-]?(?:[0-9]+\\.?[0-9]*|\\.[0-9]+)(?:[eE][+-]?[0-9]+)?\\s*$"}],"title":"30EcommerceStoresStoreIdProductsProductIdPutRequestBodyContentApplicationJsonSchemaVariantsItemsPrice"},"30EcommerceStoresStoreIdProductsProductIdPutRequestBodyContentApplicationJsonSchemaVariantsItems":{"type":"object","properties":{"backorders":{"type":"string","description":"The backorders of a product variant."},"id":{"$ref":"#/components/schemas/30EcommerceStoresStoreIdProductsProductIdPutRequestBodyContentApplicationJsonSchemaVariantsItemsId","description":"A unique identifier for the product variant."},"image_url":{"type":"string","description":"The image URL for a product variant."},"inventory_quantity":{"type":"integer","description":"The inventory quantity of a product variant."},"price":{"$ref":"#/components/schemas/30EcommerceStoresStoreIdProductsProductIdPutRequestBodyContentApplicationJsonSchemaVariantsItemsPrice"},"sku":{"type":"string","description":"The stock keeping unit (SKU) of a product variant."},"title":{"type":"string","pattern":"\\S","minLength":1,"description":"The title of a product variant."},"url":{"type":"string","description":"The URL for a product variant."},"visibility":{"type":"string","description":"The visibility of a product variant."}},"required":["id","title"],"description":"Information about a specific product variant.","title":"30EcommerceStoresStoreIdProductsProductIdPutRequestBodyContentApplicationJsonSchemaVariantsItems"},"30EcommerceStoresStoreIdProductsProductIdImagesGetResponsesContentApplicationJsonSchemaLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"30EcommerceStoresStoreIdProductsProductIdImagesGetResponsesContentApplicationJsonSchemaLinksItemsMethod"},"30EcommerceStoresStoreIdProductsProductIdImagesGetResponsesContentApplicationJsonSchemaLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/30EcommerceStoresStoreIdProductsProductIdImagesGetResponsesContentApplicationJsonSchemaLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"30EcommerceStoresStoreIdProductsProductIdImagesGetResponsesContentApplicationJsonSchemaLinksItems"},"30EcommerceStoresStoreIdProductsProductIdImagesGetResponsesContentApplicationJsonSchemaImagesItemsLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"30EcommerceStoresStoreIdProductsProductIdImagesGetResponsesContentApplicationJsonSchemaImagesItemsLinksItemsMethod"},"30EcommerceStoresStoreIdProductsProductIdImagesGetResponsesContentApplicationJsonSchemaImagesItemsLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/30EcommerceStoresStoreIdProductsProductIdImagesGetResponsesContentApplicationJsonSchemaImagesItemsLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"30EcommerceStoresStoreIdProductsProductIdImagesGetResponsesContentApplicationJsonSchemaImagesItemsLinksItems"},"30EcommerceStoresStoreIdProductsProductIdImagesGetResponsesContentApplicationJsonSchemaImagesItems":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/30EcommerceStoresStoreIdProductsProductIdImagesGetResponsesContentApplicationJsonSchemaImagesItemsLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"id":{"type":"string","description":"A unique identifier for the product image."},"url":{"type":"string","description":"The URL for a product image."},"variant_ids":{"type":"array","items":{"type":"string"},"description":"The list of product variants using the image."}},"description":"Information about a specific product image.","title":"30EcommerceStoresStoreIdProductsProductIdImagesGetResponsesContentApplicationJsonSchemaImagesItems"},"ecommerce_list-store-product-images_Response_200":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/30EcommerceStoresStoreIdProductsProductIdImagesGetResponsesContentApplicationJsonSchemaLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"images":{"type":"array","items":{"$ref":"#/components/schemas/30EcommerceStoresStoreIdProductsProductIdImagesGetResponsesContentApplicationJsonSchemaImagesItems"},"description":"An array of objects, each representing a product image resource."},"product_id":{"type":"string","description":"The product id."},"store_id":{"type":"string","description":"The store id."},"total_items":{"type":"integer","description":"The total number of items matching the query regardless of pagination."}},"description":"A collection of a product's images.","title":"ecommerce_list-store-product-images_Response_200"},"30EcommerceStoresStoreIdProductsProductIdImagesPostRequestBodyContentApplicationJsonSchemaVariantIdsItems":{"oneOf":[{"type":"string"},{"type":"integer"}],"title":"30EcommerceStoresStoreIdProductsProductIdImagesPostRequestBodyContentApplicationJsonSchemaVariantIdsItems"},"30EcommerceStoresStoreIdProductsProductIdImagesPostResponsesContentApplicationJsonSchemaLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"30EcommerceStoresStoreIdProductsProductIdImagesPostResponsesContentApplicationJsonSchemaLinksItemsMethod"},"30EcommerceStoresStoreIdProductsProductIdImagesPostResponsesContentApplicationJsonSchemaLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/30EcommerceStoresStoreIdProductsProductIdImagesPostResponsesContentApplicationJsonSchemaLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"30EcommerceStoresStoreIdProductsProductIdImagesPostResponsesContentApplicationJsonSchemaLinksItems"},"ecommerce_create-store-product-image_Response_200":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/30EcommerceStoresStoreIdProductsProductIdImagesPostResponsesContentApplicationJsonSchemaLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"id":{"type":"string","description":"A unique identifier for the product image."},"url":{"type":"string","description":"The URL for a product image."},"variant_ids":{"type":"array","items":{"type":"string"},"description":"The list of product variants using the image."}},"description":"Information about a specific product image.","title":"ecommerce_create-store-product-image_Response_200"},"30EcommerceStoresStoreIdProductsProductIdImagesImageIdGetResponsesContentApplicationJsonSchemaLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"30EcommerceStoresStoreIdProductsProductIdImagesImageIdGetResponsesContentApplicationJsonSchemaLinksItemsMethod"},"30EcommerceStoresStoreIdProductsProductIdImagesImageIdGetResponsesContentApplicationJsonSchemaLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/30EcommerceStoresStoreIdProductsProductIdImagesImageIdGetResponsesContentApplicationJsonSchemaLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"30EcommerceStoresStoreIdProductsProductIdImagesImageIdGetResponsesContentApplicationJsonSchemaLinksItems"},"ecommerce_get-store-product-image_Response_200":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/30EcommerceStoresStoreIdProductsProductIdImagesImageIdGetResponsesContentApplicationJsonSchemaLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"id":{"type":"string","description":"A unique identifier for the product image."},"url":{"type":"string","description":"The URL for a product image."},"variant_ids":{"type":"array","items":{"type":"string"},"description":"The list of product variants using the image."}},"description":"Information about a specific product image.","title":"ecommerce_get-store-product-image_Response_200"},"30EcommerceStoresStoreIdProductsProductIdImagesImageIdPatchRequestBodyContentApplicationJsonSchemaVariantIdsItems":{"oneOf":[{"type":"string"},{"type":"integer"}],"title":"30EcommerceStoresStoreIdProductsProductIdImagesImageIdPatchRequestBodyContentApplicationJsonSchemaVariantIdsItems"},"30EcommerceStoresStoreIdProductsProductIdImagesImageIdPatchResponsesContentApplicationJsonSchemaLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"30EcommerceStoresStoreIdProductsProductIdImagesImageIdPatchResponsesContentApplicationJsonSchemaLinksItemsMethod"},"30EcommerceStoresStoreIdProductsProductIdImagesImageIdPatchResponsesContentApplicationJsonSchemaLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/30EcommerceStoresStoreIdProductsProductIdImagesImageIdPatchResponsesContentApplicationJsonSchemaLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"30EcommerceStoresStoreIdProductsProductIdImagesImageIdPatchResponsesContentApplicationJsonSchemaLinksItems"},"ecommerce_update-store-product-image_Response_200":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/30EcommerceStoresStoreIdProductsProductIdImagesImageIdPatchResponsesContentApplicationJsonSchemaLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"id":{"type":"string","description":"A unique identifier for the product image."},"url":{"type":"string","description":"The URL for a product image."},"variant_ids":{"type":"array","items":{"type":"string"},"description":"The list of product variants using the image."}},"description":"Information about a specific product image.","title":"ecommerce_update-store-product-image_Response_200"},"30EcommerceStoresStoreIdProductsProductIdVariantsGetResponsesContentApplicationJsonSchemaLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"30EcommerceStoresStoreIdProductsProductIdVariantsGetResponsesContentApplicationJsonSchemaLinksItemsMethod"},"30EcommerceStoresStoreIdProductsProductIdVariantsGetResponsesContentApplicationJsonSchemaLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/30EcommerceStoresStoreIdProductsProductIdVariantsGetResponsesContentApplicationJsonSchemaLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"30EcommerceStoresStoreIdProductsProductIdVariantsGetResponsesContentApplicationJsonSchemaLinksItems"},"ecommerce_list-store-product-variants_Response_200":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/30EcommerceStoresStoreIdProductsProductIdVariantsGetResponsesContentApplicationJsonSchemaLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"product_id":{"type":"string","description":"The product id."},"store_id":{"type":"string","description":"The store id."},"total_items":{"type":"integer","description":"The total number of items matching the query regardless of pagination."},"variants":{"type":"array","items":{"$ref":"#/components/schemas/ECommerceProductVariant"},"description":"An array of objects, each representing a product's variants."}},"description":"A collection of a product's variants.","title":"ecommerce_list-store-product-variants_Response_200"},"30EcommerceStoresStoreIdProductsProductIdVariantsPostRequestBodyContentApplicationJsonSchemaId":{"oneOf":[{"type":"string","minLength":1},{"type":"integer"}],"description":"A unique identifier for the product variant.","title":"30EcommerceStoresStoreIdProductsProductIdVariantsPostRequestBodyContentApplicationJsonSchemaId"},"30EcommerceStoresStoreIdProductsProductIdVariantsPostRequestBodyContentApplicationJsonSchemaPrice":{"oneOf":[{"type":"number","format":"double"},{"type":"string","pattern":"^\\s*[+-]?(?:[0-9]+\\.?[0-9]*|\\.[0-9]+)(?:[eE][+-]?[0-9]+)?\\s*$"}],"title":"30EcommerceStoresStoreIdProductsProductIdVariantsPostRequestBodyContentApplicationJsonSchemaPrice"},"30EcommerceStoresStoreIdProductsProductIdVariantsVariantIdPatchRequestBodyContentApplicationJsonSchemaPrice":{"oneOf":[{"type":"number","format":"double"},{"type":"string","pattern":"^\\s*[+-]?(?:[0-9]+\\.?[0-9]*|\\.[0-9]+)(?:[eE][+-]?[0-9]+)?\\s*$"}],"title":"30EcommerceStoresStoreIdProductsProductIdVariantsVariantIdPatchRequestBodyContentApplicationJsonSchemaPrice"},"30EcommerceStoresStoreIdProductsProductIdVariantsVariantIdPutRequestBodyContentApplicationJsonSchemaPrice":{"oneOf":[{"type":"number","format":"double"},{"type":"string","pattern":"^\\s*[+-]?(?:[0-9]+\\.?[0-9]*|\\.[0-9]+)(?:[eE][+-]?[0-9]+)?\\s*$"}],"title":"30EcommerceStoresStoreIdProductsProductIdVariantsVariantIdPutRequestBodyContentApplicationJsonSchemaPrice"},"30EcommerceStoresStoreIdPromoRulesGetResponsesContentApplicationJsonSchemaLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"30EcommerceStoresStoreIdPromoRulesGetResponsesContentApplicationJsonSchemaLinksItemsMethod"},"30EcommerceStoresStoreIdPromoRulesGetResponsesContentApplicationJsonSchemaLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/30EcommerceStoresStoreIdPromoRulesGetResponsesContentApplicationJsonSchemaLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"30EcommerceStoresStoreIdPromoRulesGetResponsesContentApplicationJsonSchemaLinksItems"},"ECommercePromoRuleLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"ECommercePromoRuleLinksItemsMethod"},"ECommercePromoRuleLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/ECommercePromoRuleLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"ECommercePromoRuleLinksItems"},"ECommercePromoRuleTarget":{"type":"string","enum":["per_item","total","shipping"],"description":"The target that the discount applies to.","title":"ECommercePromoRuleTarget"},"ECommercePromoRuleType":{"type":"string","enum":["fixed","percentage"],"description":"Type of discount. For free shipping set type to fixed.","title":"ECommercePromoRuleType"},"ECommercePromoRule":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/ECommercePromoRuleLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"amount":{"type":"string","title":"float","description":"The amount of the promo code discount. If 'type' is 'fixed', the amount is treated as a monetary value. If 'type' is 'percentage', amount must be a decimal value between 0.0 and 1.0, inclusive."},"created_at_foreign":{"type":"string","format":"date-time","description":"The date and time the promotion was created in ISO 8601 format."},"description":{"type":"string","description":"The description of a promotion restricted to UTF-8 characters with max length 255."},"enabled":{"type":"boolean","description":"Whether the promo rule is currently enabled."},"ends_at":{"type":"string","format":"Promo date-time","description":"The date and time when the promotion ends. Must be after starts_at and in ISO 8601 format."},"id":{"type":"string","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."},"starts_at":{"type":"string","format":"date-time","description":"The date and time when the promotion is in effect in ISO 8601 format."},"target":{"$ref":"#/components/schemas/ECommercePromoRuleTarget","description":"The target that the discount applies to."},"title":{"type":"string","description":"The title that will show up in promotion campaign. Restricted to UTF-8 characters with max length of 100 bytes."},"type":{"$ref":"#/components/schemas/ECommercePromoRuleType","description":"Type of discount. For free shipping set type to fixed."},"updated_at_foreign":{"type":"string","format":"date-time","description":"The date and time the promotion was updated in ISO 8601 format."}},"description":"Information about an Ecommerce Store's specific Promo Rule","title":"ECommercePromoRule"},"ecommerce_list-store-promo-rules_Response_200":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/30EcommerceStoresStoreIdPromoRulesGetResponsesContentApplicationJsonSchemaLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"promo_rules":{"type":"array","items":{"$ref":"#/components/schemas/ECommercePromoRule"},"description":"An array of objects, each representing promo rules defined for a store."},"store_id":{"type":"string","description":"The store id."},"total_items":{"type":"integer","description":"The total number of items matching the query regardless of pagination."}},"description":"A collection of the store's promo rules.","title":"ecommerce_list-store-promo-rules_Response_200"},"30EcommerceStoresStoreIdPromoRulesPostRequestBodyContentApplicationJsonSchemaAmount":{"oneOf":[{"type":"number","format":"double"},{"type":"string","pattern":"^\\s*[+-]?(?:[0-9]+\\.?[0-9]*|\\.[0-9]+)(?:[eE][+-]?[0-9]+)?\\s*$"}],"title":"30EcommerceStoresStoreIdPromoRulesPostRequestBodyContentApplicationJsonSchemaAmount"},"30EcommerceStoresStoreIdPromoRulesPostRequestBodyContentApplicationJsonSchemaEndsAt0":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"},{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}(:\\d{2})?$"},{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d{3})?[+-]\\d{4}$"},{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[+-]\\d{2}:\\d{2})$"},{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2} [A-Z][A-Z0-9+\\-]{1,4}$"},{"type":"string","pattern":"^\\d{1,2}/\\d{2}/\\d{4} \\d{1,2}:\\d{2}:\\d{2} (AM|PM)$"}],"title":"30EcommerceStoresStoreIdPromoRulesPostRequestBodyContentApplicationJsonSchemaEndsAt0"},"30EcommerceStoresStoreIdPromoRulesPostRequestBodyContentApplicationJsonSchemaEndsAt1":{"type":"string","enum":["","0000-00-00","0000-00-00 00:00:00"],"title":"30EcommerceStoresStoreIdPromoRulesPostRequestBodyContentApplicationJsonSchemaEndsAt1"},"30EcommerceStoresStoreIdPromoRulesPostRequestBodyContentApplicationJsonSchemaEndsAt":{"oneOf":[{"$ref":"#/components/schemas/30EcommerceStoresStoreIdPromoRulesPostRequestBodyContentApplicationJsonSchemaEndsAt0"},{"$ref":"#/components/schemas/30EcommerceStoresStoreIdPromoRulesPostRequestBodyContentApplicationJsonSchemaEndsAt1"}],"title":"30EcommerceStoresStoreIdPromoRulesPostRequestBodyContentApplicationJsonSchemaEndsAt"},"30EcommerceStoresStoreIdPromoRulesPostRequestBodyContentApplicationJsonSchemaStartsAt0":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"},{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}(:\\d{2})?$"},{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d{3})?[+-]\\d{4}$"},{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[+-]\\d{2}:\\d{2})$"},{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2} [A-Z][A-Z0-9+\\-]{1,4}$"},{"type":"string","pattern":"^\\d{1,2}/\\d{2}/\\d{4} \\d{1,2}:\\d{2}:\\d{2} (AM|PM)$"}],"title":"30EcommerceStoresStoreIdPromoRulesPostRequestBodyContentApplicationJsonSchemaStartsAt0"},"30EcommerceStoresStoreIdPromoRulesPostRequestBodyContentApplicationJsonSchemaStartsAt1":{"type":"string","enum":["","0000-00-00","0000-00-00 00:00:00"],"title":"30EcommerceStoresStoreIdPromoRulesPostRequestBodyContentApplicationJsonSchemaStartsAt1"},"30EcommerceStoresStoreIdPromoRulesPostRequestBodyContentApplicationJsonSchemaStartsAt":{"oneOf":[{"$ref":"#/components/schemas/30EcommerceStoresStoreIdPromoRulesPostRequestBodyContentApplicationJsonSchemaStartsAt0"},{"$ref":"#/components/schemas/30EcommerceStoresStoreIdPromoRulesPostRequestBodyContentApplicationJsonSchemaStartsAt1"}],"title":"30EcommerceStoresStoreIdPromoRulesPostRequestBodyContentApplicationJsonSchemaStartsAt"},"30EcommerceStoresStoreIdPromoRulesPostRequestBodyContentApplicationJsonSchemaTarget":{"type":"string","enum":["per_item","total","shipping"],"description":"The target that the discount applies to.","title":"30EcommerceStoresStoreIdPromoRulesPostRequestBodyContentApplicationJsonSchemaTarget"},"30EcommerceStoresStoreIdPromoRulesPostRequestBodyContentApplicationJsonSchemaType":{"type":"string","enum":["fixed","percentage"],"description":"Type of discount. For free shipping set type to fixed.","title":"30EcommerceStoresStoreIdPromoRulesPostRequestBodyContentApplicationJsonSchemaType"},"30EcommerceStoresStoreIdPromoRulesPromoRuleIdPatchRequestBodyContentApplicationJsonSchemaAmount":{"oneOf":[{"type":"number","format":"double"},{"type":"string","pattern":"^\\s*[+-]?(?:[0-9]+\\.?[0-9]*|\\.[0-9]+)(?:[eE][+-]?[0-9]+)?\\s*$"}],"title":"30EcommerceStoresStoreIdPromoRulesPromoRuleIdPatchRequestBodyContentApplicationJsonSchemaAmount"},"30EcommerceStoresStoreIdPromoRulesPromoRuleIdPatchRequestBodyContentApplicationJsonSchemaEndsAt0":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"},{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}(:\\d{2})?$"},{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d{3})?[+-]\\d{4}$"},{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[+-]\\d{2}:\\d{2})$"},{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2} [A-Z][A-Z0-9+\\-]{1,4}$"},{"type":"string","pattern":"^\\d{1,2}/\\d{2}/\\d{4} \\d{1,2}:\\d{2}:\\d{2} (AM|PM)$"}],"title":"30EcommerceStoresStoreIdPromoRulesPromoRuleIdPatchRequestBodyContentApplicationJsonSchemaEndsAt0"},"30EcommerceStoresStoreIdPromoRulesPromoRuleIdPatchRequestBodyContentApplicationJsonSchemaEndsAt1":{"type":"string","enum":["","0000-00-00","0000-00-00 00:00:00"],"title":"30EcommerceStoresStoreIdPromoRulesPromoRuleIdPatchRequestBodyContentApplicationJsonSchemaEndsAt1"},"30EcommerceStoresStoreIdPromoRulesPromoRuleIdPatchRequestBodyContentApplicationJsonSchemaEndsAt":{"oneOf":[{"$ref":"#/components/schemas/30EcommerceStoresStoreIdPromoRulesPromoRuleIdPatchRequestBodyContentApplicationJsonSchemaEndsAt0"},{"$ref":"#/components/schemas/30EcommerceStoresStoreIdPromoRulesPromoRuleIdPatchRequestBodyContentApplicationJsonSchemaEndsAt1"}],"title":"30EcommerceStoresStoreIdPromoRulesPromoRuleIdPatchRequestBodyContentApplicationJsonSchemaEndsAt"},"30EcommerceStoresStoreIdPromoRulesPromoRuleIdPatchRequestBodyContentApplicationJsonSchemaStartsAt0":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"},{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}(:\\d{2})?$"},{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d{3})?[+-]\\d{4}$"},{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[+-]\\d{2}:\\d{2})$"},{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2} [A-Z][A-Z0-9+\\-]{1,4}$"},{"type":"string","pattern":"^\\d{1,2}/\\d{2}/\\d{4} \\d{1,2}:\\d{2}:\\d{2} (AM|PM)$"}],"title":"30EcommerceStoresStoreIdPromoRulesPromoRuleIdPatchRequestBodyContentApplicationJsonSchemaStartsAt0"},"30EcommerceStoresStoreIdPromoRulesPromoRuleIdPatchRequestBodyContentApplicationJsonSchemaStartsAt1":{"type":"string","enum":["","0000-00-00","0000-00-00 00:00:00"],"title":"30EcommerceStoresStoreIdPromoRulesPromoRuleIdPatchRequestBodyContentApplicationJsonSchemaStartsAt1"},"30EcommerceStoresStoreIdPromoRulesPromoRuleIdPatchRequestBodyContentApplicationJsonSchemaStartsAt":{"oneOf":[{"$ref":"#/components/schemas/30EcommerceStoresStoreIdPromoRulesPromoRuleIdPatchRequestBodyContentApplicationJsonSchemaStartsAt0"},{"$ref":"#/components/schemas/30EcommerceStoresStoreIdPromoRulesPromoRuleIdPatchRequestBodyContentApplicationJsonSchemaStartsAt1"}],"title":"30EcommerceStoresStoreIdPromoRulesPromoRuleIdPatchRequestBodyContentApplicationJsonSchemaStartsAt"},"30EcommerceStoresStoreIdPromoRulesPromoRuleIdPatchRequestBodyContentApplicationJsonSchemaTarget":{"type":"string","enum":["per_item","total","shipping"],"description":"The target that the discount applies to.","title":"30EcommerceStoresStoreIdPromoRulesPromoRuleIdPatchRequestBodyContentApplicationJsonSchemaTarget"},"30EcommerceStoresStoreIdPromoRulesPromoRuleIdPatchRequestBodyContentApplicationJsonSchemaType":{"type":"string","enum":["fixed","percentage"],"description":"Type of discount. For free shipping set type to fixed.","title":"30EcommerceStoresStoreIdPromoRulesPromoRuleIdPatchRequestBodyContentApplicationJsonSchemaType"},"30EcommerceStoresStoreIdPromoRulesPromoRuleIdPromoCodesGetResponsesContentApplicationJsonSchemaLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"30EcommerceStoresStoreIdPromoRulesPromoRuleIdPromoCodesGetResponsesContentApplicationJsonSchemaLinksItemsMethod"},"30EcommerceStoresStoreIdPromoRulesPromoRuleIdPromoCodesGetResponsesContentApplicationJsonSchemaLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/30EcommerceStoresStoreIdPromoRulesPromoRuleIdPromoCodesGetResponsesContentApplicationJsonSchemaLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"30EcommerceStoresStoreIdPromoRulesPromoRuleIdPromoCodesGetResponsesContentApplicationJsonSchemaLinksItems"},"ECommercePromoCodeLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"ECommercePromoCodeLinksItemsMethod"},"ECommercePromoCodeLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/ECommercePromoCodeLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"ECommercePromoCodeLinksItems"},"ECommercePromoCode":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/ECommercePromoCodeLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"code":{"type":"string","description":"The discount code. Restricted to UTF-8 characters with max length 50."},"created_at_foreign":{"type":"string","format":"date-time","description":"The date and time the promotion was created in ISO 8601 format."},"enabled":{"type":"boolean","description":"Whether the promo code is currently enabled."},"id":{"type":"string","description":"A unique identifier for the promo Code."},"redemption_url":{"type":"string","description":"The url that should be used in the promotion campaign restricted to UTF-8 characters with max length 2000."},"updated_at_foreign":{"type":"string","format":"date-time","description":"The date and time the promotion was updated in ISO 8601 format."},"usage_count":{"type":"integer","description":"Number of times promo code has been used."}},"description":"Information about an Ecommerce Store's specific Promo Code","title":"ECommercePromoCode"},"ecommerce_list-store-promo-rule-promo-codes_Response_200":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/30EcommerceStoresStoreIdPromoRulesPromoRuleIdPromoCodesGetResponsesContentApplicationJsonSchemaLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"promo_codes":{"type":"array","items":{"$ref":"#/components/schemas/ECommercePromoCode"},"description":"An array of objects, each representing promo codes defined for a store."},"store_id":{"type":"string","description":"The store id."},"total_items":{"type":"integer","description":"The total number of items matching the query regardless of pagination."}},"description":"A collection of the store's promo codes.","title":"ecommerce_list-store-promo-rule-promo-codes_Response_200"},"30FacebookAdsGetParametersSortField":{"type":"string","enum":["created_at","updated_at","end_time"],"title":"30FacebookAdsGetParametersSortField"},"30FacebookAdsGetParametersSortDir":{"type":"string","enum":["ASC","DESC"],"title":"30FacebookAdsGetParametersSortDir"},"30FacebookAdsGetResponsesContentApplicationJsonSchemaLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"30FacebookAdsGetResponsesContentApplicationJsonSchemaLinksItemsMethod"},"30FacebookAdsGetResponsesContentApplicationJsonSchemaLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/30FacebookAdsGetResponsesContentApplicationJsonSchemaLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"30FacebookAdsGetResponsesContentApplicationJsonSchemaLinksItems"},"FacebookAdsRecipientsSegmentOptsMatch":{"type":"string","enum":["any","all"],"description":"Segment match type.","title":"FacebookAdsRecipientsSegmentOptsMatch"},"FacebookAdsRecipientsSegmentOptsSavedSegmentId":{"oneOf":[{"type":"integer"},{"type":"string","pattern":"^[0-9]+$"}],"description":"The id for an existing saved segment.","title":"FacebookAdsRecipientsSegmentOptsSavedSegmentId"},"FacebookAdsRecipientsSegmentOpts":{"type":"object","properties":{"conditions":{"$ref":"#/components/schemas/SegmentType"},"match":{"$ref":"#/components/schemas/FacebookAdsRecipientsSegmentOptsMatch","description":"Segment match type."},"prebuilt_segment_id":{"type":"string","description":"The prebuilt segment id, if a prebuilt segment has been designated for this campaign."},"saved_segment_id":{"$ref":"#/components/schemas/FacebookAdsRecipientsSegmentOptsSavedSegmentId","description":"The id for an existing saved segment."}},"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.","title":"FacebookAdsRecipientsSegmentOpts"},"FacebookAdsRecipients":{"type":"object","properties":{"list_id":{"type":"string","description":"The unique list id."},"list_is_active":{"type":"boolean","description":"The status of the list used, namely if it's deleted or disabled."},"list_name":{"type":"string","description":"The name of the list."},"recipient_count":{"type":"integer","description":"Count of the recipients on the associated list. Formatted as an integer."},"segment_opts":{"$ref":"#/components/schemas/FacebookAdsRecipientsSegmentOpts","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."},"segment_text":{"type":"string","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."}},"description":"High level audience information for who the outreach targets.","title":"FacebookAdsRecipients"},"FacebookAdsReportSummaryEcommerce":{"type":"object","properties":{"average_order_revenue":{"type":"number","format":"double"},"currency_code":{"type":"string"},"total_revenue":{"type":"number","format":"double"}},"title":"FacebookAdsReportSummaryEcommerce"},"FacebookAdsReportSummary":{"type":"object","properties":{"click_rate":{"type":"number","format":"double"},"clicks":{"type":"integer"},"conversion_rate":{"type":"number","format":"double"},"ecommerce":{"$ref":"#/components/schemas/FacebookAdsReportSummaryEcommerce"},"engagements":{"type":"integer"},"impressions":{"type":"number","format":"double"},"open_rate":{"type":"number","format":"double"},"opens":{"type":"integer"},"proxy_excluded_open_rate":{"type":"number","format":"double"},"proxy_excluded_opens":{"type":"integer"},"proxy_excluded_unique_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"}},"description":"High level reporting stats for an outreach.","title":"FacebookAdsReportSummary"},"FacebookAdsStatus":{"type":"string","enum":["save","paused","schedule","scheduled","sending","sent","canceled","canceling","active","disconnected","somepaused","draft","completed","partialRejected","pending","rejected","published","unpublished"],"description":"The status of this outreach.","title":"FacebookAdsStatus"},"FacebookAdsType":{"type":"string","enum":["regular","email-touchpoint","plaintext","rss","reconfirm","variate","absplit","automation","facebook","google","autoresponder","transactional","page","website","social_post","survey","customer_journey","sms"],"description":"The type of outreach this object is.","title":"FacebookAdsType"},"FacebookAdsAudienceEmailSource":{"type":"object","properties":{"is_segment":{"type":"boolean","description":"Is the source reference a segment"},"list_name":{"type":"string","description":"Associated list name to the source"},"name":{"type":"string","description":"Email source name"},"segment_type":{"type":"string","description":"Segment type if this source is tied to a segment"},"type":{"type":"string","description":"Type of the email source"}},"title":"FacebookAdsAudienceEmailSource"},"FacebookAdsAudienceSourceType":{"type":"string","enum":["facebook","list"],"description":"List or Facebook based audience","title":"FacebookAdsAudienceSourceType"},"FacebookAdsAudienceTargetingSpecsGender":{"type":"string","enum":["0","1","2"],"title":"FacebookAdsAudienceTargetingSpecsGender"},"FacebookAdsAudienceTargetingSpecsInterestsItems":{"type":"object","properties":{"name":{"type":"string"}},"title":"FacebookAdsAudienceTargetingSpecsInterestsItems"},"FacebookAdsAudienceTargetingSpecsLocations":{"type":"object","properties":{"cities":{"type":"array","items":{"type":"string"}},"countries":{"type":"array","items":{"type":"string"}},"regions":{"type":"array","items":{"type":"string"}},"zips":{"type":"array","items":{"type":"string"}}},"title":"FacebookAdsAudienceTargetingSpecsLocations"},"FacebookAdsAudienceTargetingSpecs":{"type":"object","properties":{"gender":{"$ref":"#/components/schemas/FacebookAdsAudienceTargetingSpecsGender"},"interests":{"type":"array","items":{"$ref":"#/components/schemas/FacebookAdsAudienceTargetingSpecsInterestsItems"}},"locations":{"$ref":"#/components/schemas/FacebookAdsAudienceTargetingSpecsLocations"},"max_age":{"type":"integer"},"min_age":{"type":"integer"}},"title":"FacebookAdsAudienceTargetingSpecs"},"FacebookAdsAudienceType":{"type":"string","enum":["Custom Audience","Lookalike Audience","Interest-based Audience"],"description":"Type of the audience","title":"FacebookAdsAudienceType"},"FacebookAdsAudience":{"type":"object","properties":{"email_source":{"$ref":"#/components/schemas/FacebookAdsAudienceEmailSource"},"include_source_in_target":{"type":"boolean","description":"To include list contacts as part of audience"},"lookalike_country_code":{"type":"string","description":"To find similar audience in given country"},"source_type":{"$ref":"#/components/schemas/FacebookAdsAudienceSourceType","description":"List or Facebook based audience"},"targeting_specs":{"$ref":"#/components/schemas/FacebookAdsAudienceTargetingSpecs"},"type":{"$ref":"#/components/schemas/FacebookAdsAudienceType","description":"Type of the audience"}},"description":"Audience settings","title":"FacebookAdsAudience"},"FacebookAdsBudget":{"type":"object","properties":{"currency_code":{"type":"string","description":"Currency code"},"duration":{"type":"integer","description":"Duration of the ad in seconds"},"total_amount":{"type":"number","format":"double","description":"Total budget of the ad"}},"title":"FacebookAdsBudget"},"FacebookAdsChannel":{"type":"object","properties":{"fb_placement_audience":{"type":"boolean","description":"Is this for facebook audience"},"fb_placement_feed":{"type":"boolean","description":"Is this for facebook feed"},"ig_placement_feed":{"type":"boolean","description":"Is this for instagram feed"}},"description":"Channel settings","title":"FacebookAdsChannel"},"FacebookAdsContentAttachmentsItems":{"type":"object","properties":{"call_to_action":{"type":"string"},"description":{"type":"string"},"image_url":{"type":"string"},"link_url":{"type":"string"},"name":{"type":"string"}},"title":"FacebookAdsContentAttachmentsItems"},"FacebookAdsContent":{"type":"object","properties":{"attachments":{"type":"array","items":{"$ref":"#/components/schemas/FacebookAdsContentAttachmentsItems"}},"call_to_action":{"type":"string"},"description":{"type":"string"},"image_url":{"type":"string"},"link_url":{"type":"string"},"message":{"type":"string"},"title":{"type":"string"}},"title":"FacebookAdsContent"},"FacebookAdsFeedback":{"type":"object","properties":{"audience":{"type":"string","description":"Feedback regarding the audience of this Ad."},"budget":{"type":"string","description":"Feedback regarding the budget of this Ad."},"compliance":{"type":"string","description":"Feedback regarding the compliance of this Ad."},"content":{"type":"string","description":"Feedback regarding the content of this Ad."}},"description":"Check if this ad is connected to a facebook page","title":"FacebookAdsFeedback"},"FacebookAdsSite":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of this connected site."},"name":{"type":"string","description":"The name of the connected site"},"url":{"type":"string","description":"The URL for this connected site."}},"description":"Connected Site","title":"FacebookAdsSite"},"FacebookAdsLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"FacebookAdsLinksItemsMethod"},"FacebookAdsLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/FacebookAdsLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"FacebookAdsLinksItems"},"FacebookAds":{"type":"object","properties":{"canceled_at":{"type":"string","format":"date-time","description":"The date and time the outreach was canceled in ISO 8601 format."},"create_time":{"type":"string","format":"date-time","description":"The date and time the outreach was created in ISO 8601 format."},"has_segment":{"type":"boolean","description":"If this outreach targets a segment of your audience."},"id":{"type":"string","description":"Unique ID of an Outreach."},"name":{"type":"string","description":"Title or name of an Outreach."},"published_time":{"type":"string","format":"date-time","description":"The date and time the outreach was (or will be) published in ISO 8601 format."},"recipients":{"$ref":"#/components/schemas/FacebookAdsRecipients","description":"High level audience information for who the outreach targets."},"report_summary":{"$ref":"#/components/schemas/FacebookAdsReportSummary","description":"High level reporting stats for an outreach."},"show_report":{"type":"boolean","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."},"start_time":{"type":"string","format":"date-time","description":"The date and time the outreach was started in ISO 8601 format."},"status":{"$ref":"#/components/schemas/FacebookAdsStatus","description":"The status of this outreach."},"type":{"$ref":"#/components/schemas/FacebookAdsType","description":"The type of outreach this object is."},"updated_at":{"type":"string","format":"date-time","description":"The date and time the outreach was last updated in ISO 8601 format."},"web_id":{"type":"integer","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}`."},"email_source_name":{"type":"string"},"end_time":{"type":"string","format":"date-time","description":"The date and time the ad was ended in ISO 8601 format."},"needs_attention":{"type":"boolean","description":"If the ad has a problem and needs attention."},"paused_at":{"type":"string","format":"date-time","description":"The date and time the ad was paused in ISO 8601 format."},"thumbnail":{"type":"string","description":"The URL of the thumbnail for this outreach."},"was_canceled_by_facebook":{"type":"boolean"},"audience":{"$ref":"#/components/schemas/FacebookAdsAudience","description":"Audience settings"},"budget":{"$ref":"#/components/schemas/FacebookAdsBudget"},"channel":{"$ref":"#/components/schemas/FacebookAdsChannel","description":"Channel settings"},"content":{"$ref":"#/components/schemas/FacebookAdsContent"},"feedback":{"$ref":"#/components/schemas/FacebookAdsFeedback","description":"Check if this ad is connected to a facebook page"},"has_audience":{"type":"boolean","description":"Check if this ad has audience setup"},"has_content":{"type":"boolean","description":"Check if this ad has content"},"is_connected":{"type":"boolean","description":"Check if this ad is connected to a facebook page"},"site":{"$ref":"#/components/schemas/FacebookAdsSite","description":"Connected Site"},"_links":{"type":"array","items":{"$ref":"#/components/schemas/FacebookAdsLinksItems"},"description":"A list of link types and descriptions for the API schema documents."}},"description":"A facebook ad.","title":"FacebookAds"},"facebook-ads_list_Response_200":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/30FacebookAdsGetResponsesContentApplicationJsonSchemaLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"facebook_ads":{"type":"array","items":{"$ref":"#/components/schemas/FacebookAds"}},"total_items":{"type":"integer","description":"The total number of items matching the query regardless of pagination."}},"description":"Contains an array of facebook ads.","title":"facebook-ads_list_Response_200"},"30FileManagerGetResponsesContentApplicationJsonSchemaItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"30FileManagerGetResponsesContentApplicationJsonSchemaItemsMethod"},"30FileManagerGetResponsesContentApplicationJsonSchemaItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/30FileManagerGetResponsesContentApplicationJsonSchemaItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"30FileManagerGetResponsesContentApplicationJsonSchemaItems"},"30FileManagerFilesGetParametersSortField":{"type":"string","enum":["added_date","name","size"],"title":"30FileManagerFilesGetParametersSortField"},"30FileManagerFilesGetParametersSortDir":{"type":"string","enum":["ASC","DESC"],"title":"30FileManagerFilesGetParametersSortDir"},"30FileManagerFilesGetResponsesContentApplicationJsonSchemaLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"30FileManagerFilesGetResponsesContentApplicationJsonSchemaLinksItemsMethod"},"30FileManagerFilesGetResponsesContentApplicationJsonSchemaLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/30FileManagerFilesGetResponsesContentApplicationJsonSchemaLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"30FileManagerFilesGetResponsesContentApplicationJsonSchemaLinksItems"},"GalleryFileLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"GalleryFileLinksItemsMethod"},"GalleryFileLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/GalleryFileLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"GalleryFileLinksItems"},"GalleryFileType":{"type":"string","enum":["image","file"],"description":"The type of file in the File Manager.","title":"GalleryFileType"},"GalleryFile":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/GalleryFileLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"created_at":{"type":"string","format":"date-time","description":"The date and time a file was added to the File Manager in ISO 8601 format."},"created_by":{"type":"string","description":"The username of the profile that uploaded the file."},"folder_id":{"type":"integer","description":"The id of the folder."},"full_size_url":{"type":"string","format":"uri","description":"The url of the full-size file."},"height":{"type":"integer","description":"The height of an image."},"id":{"type":"integer","description":"The unique id of the file."},"name":{"type":"string","description":"The name of the file."},"size":{"type":"integer","description":"The size of the file in bytes."},"thumbnail_url":{"type":"string","format":"uri","description":"The url of the thumbnail preview."},"type":{"$ref":"#/components/schemas/GalleryFileType","description":"The type of file in the File Manager."},"width":{"type":"integer","description":"The width of the image."}},"description":"An individual file listed in the File Manager.","title":"GalleryFile"},"file-manager_list-files_Response_200":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/30FileManagerFilesGetResponsesContentApplicationJsonSchemaLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"files":{"type":"array","items":{"$ref":"#/components/schemas/GalleryFile"},"description":" A list of files and images in an account."},"total_file_size":{"type":"number","format":"double","description":"The total size of all File Manager files in bytes."},"total_items":{"type":"integer","description":"The total number of items matching the query regardless of pagination."}},"description":"A list of available images and files stored in the File Manager for the account.","title":"file-manager_list-files_Response_200"},"30FileManagerFoldersGetResponsesContentApplicationJsonSchemaLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"30FileManagerFoldersGetResponsesContentApplicationJsonSchemaLinksItemsMethod"},"30FileManagerFoldersGetResponsesContentApplicationJsonSchemaLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/30FileManagerFoldersGetResponsesContentApplicationJsonSchemaLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"30FileManagerFoldersGetResponsesContentApplicationJsonSchemaLinksItems"},"30FileManagerFoldersGetResponsesContentApplicationJsonSchemaFoldersItemsLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"30FileManagerFoldersGetResponsesContentApplicationJsonSchemaFoldersItemsLinksItemsMethod"},"30FileManagerFoldersGetResponsesContentApplicationJsonSchemaFoldersItemsLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/30FileManagerFoldersGetResponsesContentApplicationJsonSchemaFoldersItemsLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"30FileManagerFoldersGetResponsesContentApplicationJsonSchemaFoldersItemsLinksItems"},"30FileManagerFoldersGetResponsesContentApplicationJsonSchemaFoldersItems":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/30FileManagerFoldersGetResponsesContentApplicationJsonSchemaFoldersItemsLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"created_at":{"type":"string","format":"date-time","description":"The date and time a file was added to the File Manager in ISO 8601 format."},"created_by":{"type":"string","description":"The username of the profile that created the folder."},"file_count":{"type":"integer","description":"The number of files in the folder."},"id":{"type":"integer","description":"The unique id for the folder."},"name":{"type":"string","description":"The name of the folder."}},"description":"An individual folder listed in the File Manager.","title":"30FileManagerFoldersGetResponsesContentApplicationJsonSchemaFoldersItems"},"file-manager_list-folders_Response_200":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/30FileManagerFoldersGetResponsesContentApplicationJsonSchemaLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"folders":{"type":"array","items":{"$ref":"#/components/schemas/30FileManagerFoldersGetResponsesContentApplicationJsonSchemaFoldersItems"},"description":"A list of all folders in the File Manager."},"total_items":{"type":"integer","description":"The total number of items matching the query regardless of pagination."}},"description":"A list of all folders in the File Manager.","title":"file-manager_list-folders_Response_200"},"30FileManagerFoldersPostResponsesContentApplicationJsonSchemaLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"30FileManagerFoldersPostResponsesContentApplicationJsonSchemaLinksItemsMethod"},"30FileManagerFoldersPostResponsesContentApplicationJsonSchemaLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/30FileManagerFoldersPostResponsesContentApplicationJsonSchemaLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"30FileManagerFoldersPostResponsesContentApplicationJsonSchemaLinksItems"},"file-manager_create-folder_Response_200":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/30FileManagerFoldersPostResponsesContentApplicationJsonSchemaLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"created_at":{"type":"string","format":"date-time","description":"The date and time a file was added to the File Manager in ISO 8601 format."},"created_by":{"type":"string","description":"The username of the profile that created the folder."},"file_count":{"type":"integer","description":"The number of files in the folder."},"id":{"type":"integer","description":"The unique id for the folder."},"name":{"type":"string","description":"The name of the folder."}},"description":"An individual folder listed in the File Manager.","title":"file-manager_create-folder_Response_200"},"30FileManagerFoldersFolderIdGetResponsesContentApplicationJsonSchemaLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"30FileManagerFoldersFolderIdGetResponsesContentApplicationJsonSchemaLinksItemsMethod"},"30FileManagerFoldersFolderIdGetResponsesContentApplicationJsonSchemaLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/30FileManagerFoldersFolderIdGetResponsesContentApplicationJsonSchemaLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"30FileManagerFoldersFolderIdGetResponsesContentApplicationJsonSchemaLinksItems"},"file-manager_get-folder_Response_200":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/30FileManagerFoldersFolderIdGetResponsesContentApplicationJsonSchemaLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"created_at":{"type":"string","format":"date-time","description":"The date and time a file was added to the File Manager in ISO 8601 format."},"created_by":{"type":"string","description":"The username of the profile that created the folder."},"file_count":{"type":"integer","description":"The number of files in the folder."},"id":{"type":"integer","description":"The unique id for the folder."},"name":{"type":"string","description":"The name of the folder."}},"description":"An individual folder listed in the File Manager.","title":"file-manager_get-folder_Response_200"},"30FileManagerFoldersFolderIdPatchResponsesContentApplicationJsonSchemaLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"30FileManagerFoldersFolderIdPatchResponsesContentApplicationJsonSchemaLinksItemsMethod"},"30FileManagerFoldersFolderIdPatchResponsesContentApplicationJsonSchemaLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/30FileManagerFoldersFolderIdPatchResponsesContentApplicationJsonSchemaLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"30FileManagerFoldersFolderIdPatchResponsesContentApplicationJsonSchemaLinksItems"},"file-manager_update-folder_Response_200":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/30FileManagerFoldersFolderIdPatchResponsesContentApplicationJsonSchemaLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"created_at":{"type":"string","format":"date-time","description":"The date and time a file was added to the File Manager in ISO 8601 format."},"created_by":{"type":"string","description":"The username of the profile that created the folder."},"file_count":{"type":"integer","description":"The number of files in the folder."},"id":{"type":"integer","description":"The unique id for the folder."},"name":{"type":"string","description":"The name of the folder."}},"description":"An individual folder listed in the File Manager.","title":"file-manager_update-folder_Response_200"},"30FileManagerFoldersFolderIdFilesGetParametersSortField":{"type":"string","enum":["added_date","name","size"],"title":"30FileManagerFoldersFolderIdFilesGetParametersSortField"},"30FileManagerFoldersFolderIdFilesGetParametersSortDir":{"type":"string","enum":["ASC","DESC"],"title":"30FileManagerFoldersFolderIdFilesGetParametersSortDir"},"30FileManagerFoldersFolderIdFilesGetResponsesContentApplicationJsonSchemaLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"30FileManagerFoldersFolderIdFilesGetResponsesContentApplicationJsonSchemaLinksItemsMethod"},"30FileManagerFoldersFolderIdFilesGetResponsesContentApplicationJsonSchemaLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/30FileManagerFoldersFolderIdFilesGetResponsesContentApplicationJsonSchemaLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"30FileManagerFoldersFolderIdFilesGetResponsesContentApplicationJsonSchemaLinksItems"},"file-manager_list-folder-files_Response_200":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/30FileManagerFoldersFolderIdFilesGetResponsesContentApplicationJsonSchemaLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"files":{"type":"array","items":{"$ref":"#/components/schemas/GalleryFile"},"description":" A list of files and images in an account."},"total_file_size":{"type":"number","format":"double","description":"The total size of all File Manager files in bytes."},"total_items":{"type":"integer","description":"The total number of items matching the query regardless of pagination."}},"description":"A list of available images and files stored in the File Manager for the account.","title":"file-manager_list-folder-files_Response_200"},"30LandingPagesGetParametersSortDir":{"type":"string","enum":["ASC","DESC"],"title":"30LandingPagesGetParametersSortDir"},"30LandingPagesGetParametersSortField":{"type":"string","enum":["created_at","updated_at"],"title":"30LandingPagesGetParametersSortField"},"30LandingPagesGetResponsesContentApplicationJsonSchemaLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"30LandingPagesGetResponsesContentApplicationJsonSchemaLinksItemsMethod"},"30LandingPagesGetResponsesContentApplicationJsonSchemaLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/30LandingPagesGetResponsesContentApplicationJsonSchemaLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"30LandingPagesGetResponsesContentApplicationJsonSchemaLinksItems"},"LandingPageLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"LandingPageLinksItemsMethod"},"LandingPageLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/LandingPageLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"LandingPageLinksItems"},"LandingPageStatus":{"type":"string","enum":["published","unpublished","draft"],"description":"The status of this landing page.","title":"LandingPageStatus"},"LandingPageTracking":{"type":"object","properties":{"enable_restricted_data_processing":{"type":"boolean","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/)."},"track_with_mailchimp":{"type":"boolean","description":"Use cookies to track unique visitors and calculate overall conversion rate. Learn more [here](https://mailchimp.com/help/use-track-mailchimp/)."}},"description":"The tracking settings applied to this landing page.","title":"LandingPageTracking"},"LandingPage":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/LandingPageLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"created_at":{"type":"string","format":"date-time","description":"The time this landing page was created."},"created_by_source":{"type":"string","description":"Created by mobile or web"},"description":{"type":"string","description":"The description of this landing page."},"id":{"type":"string","description":"A string that uniquely identifies this landing page."},"list_id":{"type":"string","description":"The list's ID associated with this landing page."},"name":{"type":"string","description":"The name of this landing page."},"published_at":{"type":"string","format":"date-time","description":"The time this landing page was published."},"status":{"$ref":"#/components/schemas/LandingPageStatus","description":"The status of this landing page."},"store_id":{"type":"string","description":"The ID of the store associated with this landing page."},"template_id":{"type":"integer","description":"The template_id of this landing page."},"title":{"type":"string","description":"The title of this landing page seen in the browser's title bar."},"tracking":{"$ref":"#/components/schemas/LandingPageTracking","description":"The tracking settings applied to this landing page."},"unpublished_at":{"type":"string","format":"date-time","description":"The time this landing page was unpublished."},"updated_at":{"type":"string","format":"date-time","description":"The time this landing page was updated at."},"url":{"type":"string","description":"The url of the published landing page."},"web_id":{"type":"integer","description":"The ID used in the Mailchimp web application."}},"description":"A summary of an individual landing page's settings and content.","title":"LandingPage"},"landing-pages_list_Response_200":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/30LandingPagesGetResponsesContentApplicationJsonSchemaLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"landing_pages":{"type":"array","items":{"$ref":"#/components/schemas/LandingPage"},"description":"The landing pages on the account"},"total_items":{"type":"integer","description":"The total number of items matching the query regardless of pagination."}},"description":"A collection of landing pages.","title":"landing-pages_list_Response_200"},"30LandingPagesPostRequestBodyContentApplicationJsonSchemaTracking":{"type":"object","properties":{"enable_restricted_data_processing":{"type":"boolean","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/)."},"track_with_mailchimp":{"type":"boolean","description":"Use cookies to track unique visitors and calculate overall conversion rate. Learn more [here](https://mailchimp.com/help/use-track-mailchimp/)."}},"description":"The tracking settings applied to this landing page.","title":"30LandingPagesPostRequestBodyContentApplicationJsonSchemaTracking"},"30LandingPagesPostRequestBodyContentApplicationJsonSchemaType":{"type":"string","enum":["signup","product"],"description":"The type of template the landing page has.","title":"30LandingPagesPostRequestBodyContentApplicationJsonSchemaType"},"30LandingPagesPageIdPatchRequestBodyContentApplicationJsonSchemaTracking":{"type":"object","properties":{"enable_restricted_data_processing":{"type":"boolean","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/)."},"track_with_mailchimp":{"type":"boolean","description":"Use cookies to track unique visitors and calculate overall conversion rate. Learn more [here](https://mailchimp.com/help/use-track-mailchimp/)."}},"description":"The tracking settings applied to this landing page.","title":"30LandingPagesPageIdPatchRequestBodyContentApplicationJsonSchemaTracking"},"30LandingPagesPageIdContentGetResponsesContentApplicationJsonSchemaLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"30LandingPagesPageIdContentGetResponsesContentApplicationJsonSchemaLinksItemsMethod"},"30LandingPagesPageIdContentGetResponsesContentApplicationJsonSchemaLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/30LandingPagesPageIdContentGetResponsesContentApplicationJsonSchemaLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"30LandingPagesPageIdContentGetResponsesContentApplicationJsonSchemaLinksItems"},"landing-pages_list-content_Response_200":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/30LandingPagesPageIdContentGetResponsesContentApplicationJsonSchemaLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"html":{"type":"string","description":"The raw HTML for the landing page."},"json":{"type":"string","description":"The JSON Structure for the landing page"}},"description":"The HTML content for a landing page.","title":"landing-pages_list-content_Response_200"},"30ListsGetParametersSortField":{"type":"string","enum":["date_created"],"title":"30ListsGetParametersSortField"},"30ListsGetParametersSortDir":{"type":"string","enum":["ASC","DESC"],"title":"30ListsGetParametersSortDir"},"30ListsGetResponsesContentApplicationJsonSchemaLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"30ListsGetResponsesContentApplicationJsonSchemaLinksItemsMethod"},"30ListsGetResponsesContentApplicationJsonSchemaLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/30ListsGetResponsesContentApplicationJsonSchemaLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"30ListsGetResponsesContentApplicationJsonSchemaLinksItems"},"30ListsGetResponsesContentApplicationJsonSchemaConstraints":{"type":"object","properties":{"current_total_instances":{"type":"integer","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."},"max_instances":{"type":"integer","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."},"may_create":{"type":"boolean","description":"May the user create additional instances of this resource?"}},"required":["max_instances","may_create"],"description":"Do particular authorization constraints around this collection limit creation of new instances?","title":"30ListsGetResponsesContentApplicationJsonSchemaConstraints"},"SubscriberListLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"SubscriberListLinksItemsMethod"},"SubscriberListLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/SubscriberListLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"SubscriberListLinksItems"},"SubscriberListCampaignDefaults":{"type":"object","properties":{"from_email":{"type":"string","description":"The default from email for campaigns sent to this list."},"from_name":{"type":"string","description":"The default from name for campaigns sent to this list."},"language":{"type":"string","description":"The default language for this lists's forms."},"subject":{"type":"string","description":"The default subject line for campaigns sent to this list."}},"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.","title":"SubscriberListCampaignDefaults"},"SubscriberListContact":{"type":"object","properties":{"address1":{"type":"string","description":"The street address for the list contact."},"address2":{"type":"string","description":"The street address for the list contact."},"city":{"type":"string","description":"The city for the list contact."},"company":{"type":"string","description":"The company name for the list."},"country":{"type":"string","description":"A two-character ISO3166 country code. Defaults to US if invalid."},"phone":{"type":"string","description":"The phone number for the list contact."},"state":{"type":"string","description":"The state for the list contact."},"zip":{"type":"string","description":"The postal or zip code for the list contact."}},"description":"[Contact information displayed in campaign footers](https://mailchimp.com/help/about-campaign-footers/) to comply with international spam laws.","title":"SubscriberListContact"},"SubscriberListStats":{"type":"object","properties":{"avg_sub_rate":{"type":"number","format":"double","description":"The average number of subscriptions per month for the list (not returned if we haven't calculated it yet)."},"avg_unsub_rate":{"type":"number","format":"double","description":"The average number of unsubscriptions per month for the list (not returned if we haven't calculated it yet)."},"campaign_count":{"type":"integer","description":"The number of campaigns in any status that use this list."},"campaign_last_sent":{"type":"string","format":"date-time","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."},"cleaned_count":{"type":"integer","description":"The number of members cleaned from the list."},"cleaned_count_since_send":{"type":"integer","description":"The number of members cleaned from the list since the last campaign was sent."},"click_rate":{"type":"number","format":"double","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)."},"last_sub_date":{"type":"string","format":"date-time","description":"The date and time of the last time someone subscribed to this list in ISO 8601 format."},"last_unsub_date":{"type":"string","format":"date-time","description":"The date and time of the last time someone unsubscribed from this list in ISO 8601 format."},"member_count":{"type":"integer","description":"The number of active members in the list."},"member_count_since_send":{"type":"integer","description":"The number of active members in the list since the last campaign was sent."},"merge_field_count":{"type":"integer","description":"The number of merge fields ([audience field](https://mailchimp.com/help/getting-started-with-merge-tags/)) for this list (doesn't include EMAIL)."},"open_rate":{"type":"number","format":"double","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)."},"target_sub_rate":{"type":"number","format":"double","description":"The target number of subscriptions per month for the list to keep it growing (not returned if we haven't calculated it yet)."},"total_contacts":{"type":"integer","description":"An approximate count of subscribed, unsubscribed, and transactional contacts in the list. Does not include cleaned, archived, pending, or contacts that need to be reconfirmed. Requires the (deprecated) include_total_contacts query parameter to be included; for a complete audience contact count, use the /audiences endpoint instead."},"unsubscribe_count":{"type":"integer","description":"The number of members who have unsubscribed from the list."},"unsubscribe_count_since_send":{"type":"integer","description":"The number of members who have unsubscribed since the last campaign was sent."}},"description":"Stats for the list. Many of these are cached for at least five minutes.","title":"SubscriberListStats"},"SubscriberListVisibility":{"type":"string","enum":["pub","prv"],"description":"Legacy - visibility settings are no longer used","title":"SubscriberListVisibility"},"SubscriberList":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/SubscriberListLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"beamer_address":{"type":"string","description":"The list's [Email Beamer](https://mailchimp.com/help/use-email-beamer-to-create-a-campaign/) address."},"campaign_defaults":{"$ref":"#/components/schemas/SubscriberListCampaignDefaults","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."},"contact":{"$ref":"#/components/schemas/SubscriberListContact","description":"[Contact information displayed in campaign footers](https://mailchimp.com/help/about-campaign-footers/) to comply with international spam laws."},"date_created":{"type":"string","format":"date-time","description":"The date and time that this list was created in ISO 8601 format."},"double_optin":{"type":"boolean","default":false,"description":"Whether or not to require the subscriber to confirm subscription via email."},"email_type_option":{"type":"boolean","description":"Whether the list supports [multiple formats for emails](https://mailchimp.com/help/audience-settings-and-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."},"has_welcome":{"type":"boolean","default":false,"description":"Whether or not this list has a welcome automation connected. Welcome Automations: welcomeSeries, singleWelcome, emailFollowup."},"id":{"type":"string","description":"A string that uniquely identifies this list."},"list_rating":{"type":"integer","description":"An auto-generated activity score for the list (0-5)."},"marketing_permissions":{"type":"boolean","default":false,"description":"Whether or not the list has marketing permissions (eg. GDPR) enabled."},"modules":{"type":"array","items":{"type":"string"},"description":"Any list-specific modules installed for this list."},"name":{"type":"string","description":"The name of the list."},"notify_on_subscribe":{"type":"string","default":false,"description":"The email address to send [subscribe notifications](https://mailchimp.com/help/change-subscribe-and-unsubscribe-notifications/) to."},"notify_on_unsubscribe":{"type":"string","default":false,"description":"The email address to send [unsubscribe notifications](https://mailchimp.com/help/change-subscribe-and-unsubscribe-notifications/) to."},"permission_reminder":{"type":"string","description":"The [permission reminder](https://mailchimp.com/help/edit-the-permission-reminder/) for the list."},"stats":{"$ref":"#/components/schemas/SubscriberListStats","description":"Stats for the list. Many of these are cached for at least five minutes."},"subscribe_url_long":{"type":"string","description":"The full version of this list's subscribe form (host will vary)."},"subscribe_url_short":{"type":"string","description":"Our [url shortened](https://mailchimp.com/help/share-your-signup-form/) version of this list's subscribe form."},"use_archive_bar":{"type":"boolean","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."},"visibility":{"$ref":"#/components/schemas/SubscriberListVisibility","description":"Legacy - visibility settings are no longer used"},"web_id":{"type":"integer","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}`."}},"description":"Information about a specific list.","title":"SubscriberList"},"lists_list_Response_200":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/30ListsGetResponsesContentApplicationJsonSchemaLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"constraints":{"$ref":"#/components/schemas/30ListsGetResponsesContentApplicationJsonSchemaConstraints","description":"Do particular authorization constraints around this collection limit creation of new instances?"},"lists":{"type":"array","items":{"$ref":"#/components/schemas/SubscriberList"},"description":"An array of objects, each representing a list."},"total_items":{"type":"integer","description":"The total number of items matching the query regardless of pagination."}},"required":["lists"],"description":"A collection of subscriber lists for this account.","title":"lists_list_Response_200"},"30ListsPostRequestBodyContentApplicationJsonSchemaCampaignDefaults":{"type":"object","properties":{"from_email":{"type":"string","minLength":1,"description":"The default from email for campaigns sent to this list."},"from_name":{"type":"string","description":"The default from name for campaigns sent to this list."},"language":{"type":"string","description":"The default language for this lists's forms."},"subject":{"type":"string","description":"The default subject line for campaigns sent to this list."}},"required":["from_email","from_name","language","subject"],"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.","title":"30ListsPostRequestBodyContentApplicationJsonSchemaCampaignDefaults"},"30ListsPostRequestBodyContentApplicationJsonSchemaContact":{"type":"object","properties":{"address1":{"type":"string","minLength":1,"description":"The street address for the list contact."},"address2":{"type":"string","description":"The street address for the list contact."},"city":{"type":"string","minLength":1,"description":"The city for the list contact."},"company":{"type":"string","description":"The company name for the list."},"country":{"type":"string","minLength":1,"description":"A two-character ISO3166 country code. Defaults to US if invalid."},"phone":{"type":"string","description":"The phone number for the list contact."},"state":{"type":"string","description":"The state for the list contact."},"zip":{"type":"string","description":"The postal or zip code for the list contact."}},"required":["address1","city","company","country"],"description":"[Contact information displayed in campaign footers](https://mailchimp.com/help/about-campaign-footers/) to comply with international spam laws.","title":"30ListsPostRequestBodyContentApplicationJsonSchemaContact"},"30ListsListIdPatchRequestBodyContentApplicationJsonSchemaCampaignDefaults":{"type":"object","properties":{"from_email":{"type":"string","description":"The default from email for campaigns sent to this list."},"from_name":{"type":"string","description":"The default from name for campaigns sent to this list."},"language":{"type":"string","description":"The default language for this lists's forms."},"subject":{"type":"string","description":"The default subject line for campaigns sent to this list."}},"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.","title":"30ListsListIdPatchRequestBodyContentApplicationJsonSchemaCampaignDefaults"},"30ListsListIdPatchRequestBodyContentApplicationJsonSchemaContact":{"type":"object","properties":{"address1":{"type":"string","description":"The street address for the list contact."},"address2":{"type":"string","description":"The street address for the list contact."},"city":{"type":"string","description":"The city for the list contact."},"company":{"type":"string","description":"The company name for the list."},"country":{"type":"string","description":"A two-character ISO3166 country code. Defaults to US if invalid."},"phone":{"type":"string","description":"The phone number for the list contact."},"state":{"type":"string","description":"The state for the list contact."},"zip":{"type":"string","description":"The postal or zip code for the list contact."}},"description":"[Contact information displayed in campaign footers](https://mailchimp.com/help/about-campaign-footers/) to comply with international spam laws.","title":"30ListsListIdPatchRequestBodyContentApplicationJsonSchemaContact"},"30ListsListIdPostRequestBodyContentApplicationJsonSchemaMembersItems":{"oneOf":[{"description":"Any type"},{"description":"Any type"}],"description":"Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed.","title":"30ListsListIdPostRequestBodyContentApplicationJsonSchemaMembersItems"},"30ListsListIdPostResponsesContentApplicationJsonSchemaLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"30ListsListIdPostResponsesContentApplicationJsonSchemaLinksItemsMethod"},"30ListsListIdPostResponsesContentApplicationJsonSchemaLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/30ListsListIdPostResponsesContentApplicationJsonSchemaLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"30ListsListIdPostResponsesContentApplicationJsonSchemaLinksItems"},"30ListsListIdPostResponsesContentApplicationJsonSchemaErrorsItemsErrorCode":{"type":"string","enum":["ERROR_CONTACT_EXISTS","ERROR_GENERIC"],"description":"A unique code that identifies this specifc error.","title":"30ListsListIdPostResponsesContentApplicationJsonSchemaErrorsItemsErrorCode"},"30ListsListIdPostResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"email_address":{"type":"string","description":"The email address that could not be added or updated."},"error":{"type":"string","description":"The error message indicating why the email address could not be added or updated."},"error_code":{"$ref":"#/components/schemas/30ListsListIdPostResponsesContentApplicationJsonSchemaErrorsItemsErrorCode","description":"A unique code that identifies this specifc error."},"field":{"type":"string","description":"If the error is field-related, information about which field is at issue."},"field_message":{"type":"string","description":"Message indicating how to resolve a field-related error."}},"title":"30ListsListIdPostResponsesContentApplicationJsonSchemaErrorsItems"},"ListsPostLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"ListsPostLinksItemsMethod"},"ListsPostLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/ListsPostLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"ListsPostLinksItems"},"ListsPostLastNote":{"type":"object","properties":{"created_at":{"type":"string","format":"date-time","description":"The date and time the note was created in ISO 8601 format."},"created_by":{"type":"string","description":"The author of the note."},"note":{"type":"string","description":"The content of the note."},"note_id":{"type":"integer","description":"The note id."}},"description":"The most recent Note added about this member.","title":"ListsPostLastNote"},"ListsPostLocation":{"type":"object","properties":{"country_code":{"type":"string","description":"The unique code for the location country."},"dstoff":{"type":"integer","description":"The offset for timezones where daylight saving time is observed."},"gmtoff":{"type":"integer","description":"The time difference in hours from GMT."},"latitude":{"type":"number","format":"double","description":"The location latitude."},"longitude":{"type":"number","format":"double","description":"The location longitude."},"timezone":{"type":"string","description":"The timezone for the location."}},"description":"Subscriber location information.","title":"ListsPostLocation"},"ListsPostStats":{"type":"object","properties":{"avg_click_rate":{"type":"number","format":"double","description":"A subscriber's average clickthrough rate."},"avg_open_rate":{"type":"number","format":"double","description":"A subscriber's average open rate."}},"description":"Open and click rates for this subscriber.","title":"ListsPostStats"},"ListsPostStatus":{"type":"string","enum":["subscribed","unsubscribed","cleaned","pending","transactional"],"description":"Subscriber's current status.","title":"ListsPostStatus"},"ListsPostTagsItems":{"type":"object","properties":{"id":{"type":"integer","description":"The tag id."},"name":{"type":"string","description":"The name of the tag"}},"title":"ListsPostTagsItems"},"ListsPost":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/ListsPostLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"contact_id":{"type":"string","description":"A unique ID for the contact record."},"email_address":{"type":"string","description":"Email address for a subscriber."},"email_client":{"type":"string","description":"The list member's email client."},"email_type":{"type":"string","description":"Type of email this member asked to get ('html' or 'text')."},"id":{"type":"string","description":"The MD5 hash of the lowercase version of the list member's email address."},"interests":{"type":"object","additionalProperties":{"type":"boolean"},"description":"The key of this object's properties is the ID of the interest in question."},"ip_opt":{"type":"string","description":"The IP address the subscriber used to confirm their opt-in status."},"ip_signup":{"type":"string","description":"IP address the subscriber signed up from."},"language":{"type":"string","description":"If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/)."},"last_changed":{"type":"string","format":"date-time","description":"The date and time the member's info was last changed in ISO 8601 format."},"last_note":{"$ref":"#/components/schemas/ListsPostLastNote","description":"The most recent Note added about this member."},"list_id":{"type":"string","description":"The list id."},"location":{"$ref":"#/components/schemas/ListsPostLocation","description":"Subscriber location information."},"member_rating":{"type":"integer","description":"Star rating for this member, between 1 and 5."},"merge_fields":{"type":"object","additionalProperties":{"description":"Any type"},"description":"An individual merge var and value for a member."},"stats":{"$ref":"#/components/schemas/ListsPostStats","description":"Open and click rates for this subscriber."},"status":{"$ref":"#/components/schemas/ListsPostStatus","description":"Subscriber's current status."},"tags":{"type":"array","items":{"$ref":"#/components/schemas/ListsPostTagsItems"},"description":"The tags applied to this member."},"tags_count":{"type":"integer","description":"The number of tags applied to this member."},"timestamp_opt":{"type":"string","format":"date-time","description":"The date and time the subscriber confirmed their opt-in status in ISO 8601 format."},"timestamp_signup":{"type":"string","format":"date-time","description":"The date and time the subscriber signed up for the list in ISO 8601 format."},"unique_email_id":{"type":"string","description":"An identifier for the address across all of Mailchimp."},"vip":{"type":"boolean","description":"[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber."}},"description":"Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed.","title":"ListsPost"},"lists_batch-subscribe-or-unsubscribe_Response_200":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/30ListsListIdPostResponsesContentApplicationJsonSchemaLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"error_count":{"type":"integer","description":"The total number of items matching the query, irrespective of pagination."},"errors":{"type":"array","items":{"$ref":"#/components/schemas/30ListsListIdPostResponsesContentApplicationJsonSchemaErrorsItems"},"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."},"new_members":{"type":"array","items":{"$ref":"#/components/schemas/ListsPost"},"description":"An array of objects, each representing a new member that was added to the list."},"total_created":{"type":"integer","description":"The total number of items matching the query, irrespective of pagination."},"total_updated":{"type":"integer","description":"The total number of items matching the query, irrespective of pagination."},"updated_members":{"type":"array","items":{"$ref":"#/components/schemas/ListsPost"},"description":"An array of objects, each representing an existing list member whose subscription status was updated."}},"description":"Batch update list members.","title":"lists_batch-subscribe-or-unsubscribe_Response_200"},"30ListsListIdActivityGetResponsesContentApplicationJsonSchemaLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"30ListsListIdActivityGetResponsesContentApplicationJsonSchemaLinksItemsMethod"},"30ListsListIdActivityGetResponsesContentApplicationJsonSchemaLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/30ListsListIdActivityGetResponsesContentApplicationJsonSchemaLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"30ListsListIdActivityGetResponsesContentApplicationJsonSchemaLinksItems"},"30ListsListIdActivityGetResponsesContentApplicationJsonSchemaActivityItemsLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"30ListsListIdActivityGetResponsesContentApplicationJsonSchemaActivityItemsLinksItemsMethod"},"30ListsListIdActivityGetResponsesContentApplicationJsonSchemaActivityItemsLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/30ListsListIdActivityGetResponsesContentApplicationJsonSchemaActivityItemsLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"30ListsListIdActivityGetResponsesContentApplicationJsonSchemaActivityItemsLinksItems"},"30ListsListIdActivityGetResponsesContentApplicationJsonSchemaActivityItems":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/30ListsListIdActivityGetResponsesContentApplicationJsonSchemaActivityItemsLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"day":{"type":"string","description":"The date for the activity summary."},"emails_sent":{"type":"integer","description":"The total number of emails sent on the date for the activity summary."},"hard_bounce":{"type":"integer","description":"The number of hard bounces."},"other_adds":{"type":"integer","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."},"other_removes":{"type":"integer","description":"The number of subscribers who may have been removed outside of unsubscribing or reporting an email as spam (for example, deleted subscribers)."},"recipient_clicks":{"type":"integer","description":"The number of clicks."},"soft_bounce":{"type":"integer","description":"The number of soft bounces"},"subs":{"type":"integer","description":"The number of subscribes."},"unique_opens":{"type":"integer","description":"The number of unique opens."},"unsubs":{"type":"integer","description":"The number of unsubscribes."}},"description":"One day's worth of list activity. Doesn't include Automation activity.","title":"30ListsListIdActivityGetResponsesContentApplicationJsonSchemaActivityItems"},"lists_list-activity_Response_200":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/30ListsListIdActivityGetResponsesContentApplicationJsonSchemaLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"activity":{"type":"array","items":{"$ref":"#/components/schemas/30ListsListIdActivityGetResponsesContentApplicationJsonSchemaActivityItems"},"description":"Recent list activity."},"list_id":{"type":"string","description":"The unique id for the list."},"total_items":{"type":"integer","description":"The total number of items matching the query regardless of pagination."}},"description":"Up to the previous 180 days of daily detailed aggregated activity stats for a specific list. Does not include AutoResponder or Automation activity.","title":"lists_list-activity_Response_200"},"30ListsListIdClientsGetResponsesContentApplicationJsonSchemaLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"30ListsListIdClientsGetResponsesContentApplicationJsonSchemaLinksItemsMethod"},"30ListsListIdClientsGetResponsesContentApplicationJsonSchemaLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/30ListsListIdClientsGetResponsesContentApplicationJsonSchemaLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"30ListsListIdClientsGetResponsesContentApplicationJsonSchemaLinksItems"},"30ListsListIdClientsGetResponsesContentApplicationJsonSchemaClientsItems":{"type":"object","properties":{"client":{"type":"string","description":"The name of the email client."},"members":{"type":"integer","description":"The number of subscribed members who used this email client."}},"description":"The email client.","title":"30ListsListIdClientsGetResponsesContentApplicationJsonSchemaClientsItems"},"lists_list-clients_Response_200":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/30ListsListIdClientsGetResponsesContentApplicationJsonSchemaLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"clients":{"type":"array","items":{"$ref":"#/components/schemas/30ListsListIdClientsGetResponsesContentApplicationJsonSchemaClientsItems"},"description":"An array of top email clients."},"list_id":{"type":"string","description":"The list id."},"total_items":{"type":"integer","description":"The total number of items matching the query regardless of pagination."}},"description":"The top email clients based on user-agent strings.","title":"lists_list-clients_Response_200"},"30ListsListIdGrowthHistoryGetParametersSortField":{"type":"string","enum":["month"],"title":"30ListsListIdGrowthHistoryGetParametersSortField"},"30ListsListIdGrowthHistoryGetParametersSortDir":{"type":"string","enum":["ASC","DESC"],"title":"30ListsListIdGrowthHistoryGetParametersSortDir"},"30ListsListIdGrowthHistoryGetResponsesContentApplicationJsonSchemaLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"30ListsListIdGrowthHistoryGetResponsesContentApplicationJsonSchemaLinksItemsMethod"},"30ListsListIdGrowthHistoryGetResponsesContentApplicationJsonSchemaLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/30ListsListIdGrowthHistoryGetResponsesContentApplicationJsonSchemaLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"30ListsListIdGrowthHistoryGetResponsesContentApplicationJsonSchemaLinksItems"},"GrowthHistoryLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"GrowthHistoryLinksItemsMethod"},"GrowthHistoryLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/GrowthHistoryLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"GrowthHistoryLinksItems"},"GrowthHistory":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/GrowthHistoryLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"cleaned":{"type":"integer","description":"Newly cleaned (hard-bounced) members on the list for a specific month."},"deleted":{"type":"integer","description":"Newly deleted members on the list for a specific month."},"existing":{"type":"integer","description":"(deprecated)"},"imports":{"type":"integer","description":"(deprecated)"},"list_id":{"type":"string","description":"The list id for the growth activity report."},"month":{"type":"string","description":"The month that the growth history is describing."},"optins":{"type":"integer","description":"(deprecated)"},"pending":{"type":"integer","description":"Pending members on the list for a specific month."},"reconfirm":{"type":"integer","description":"Newly reconfirmed members on the list for a specific month."},"subscribed":{"type":"integer","description":"Total subscribed members on the list at the end of the month."},"transactional":{"type":"integer","description":"Subscribers that have been sent transactional emails via Mandrill."},"unsubscribed":{"type":"integer","description":"Newly unsubscribed members on the list for a specific month."}},"description":"A summary of a specific list's growth activity for a specific month and year.","title":"GrowthHistory"},"lists_list-growth-history_Response_200":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/30ListsListIdGrowthHistoryGetResponsesContentApplicationJsonSchemaLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"history":{"type":"array","items":{"$ref":"#/components/schemas/GrowthHistory"},"description":"An array of objects, each representing a monthly growth report for a list."},"list_id":{"type":"string","description":"The list id."},"total_items":{"type":"integer","description":"The total number of items matching the query regardless of pagination."}},"description":"A month-by-month summary of a specific list's growth activity.","title":"lists_list-growth-history_Response_200"},"30ListsListIdLocationsGetResponsesContentApplicationJsonSchemaLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"30ListsListIdLocationsGetResponsesContentApplicationJsonSchemaLinksItemsMethod"},"30ListsListIdLocationsGetResponsesContentApplicationJsonSchemaLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/30ListsListIdLocationsGetResponsesContentApplicationJsonSchemaLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"30ListsListIdLocationsGetResponsesContentApplicationJsonSchemaLinksItems"},"30ListsListIdLocationsGetResponsesContentApplicationJsonSchemaLocationsItems":{"type":"object","properties":{"cc":{"type":"string","description":"The ISO 3166 2 digit country code."},"country":{"type":"string","description":"The name of the country."},"percent":{"type":"number","format":"double","description":"The percent of subscribers in the country."},"total":{"type":"integer","description":"The total number of subscribers in the country."}},"title":"30ListsListIdLocationsGetResponsesContentApplicationJsonSchemaLocationsItems"},"lists_list-locations_Response_200":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/30ListsListIdLocationsGetResponsesContentApplicationJsonSchemaLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"list_id":{"type":"string","description":"The unique id for the list."},"locations":{"type":"array","items":{"$ref":"#/components/schemas/30ListsListIdLocationsGetResponsesContentApplicationJsonSchemaLocationsItems"},"description":"An array of objects, each representing a list's top subscriber locations."},"total_items":{"type":"integer","description":"The total number of items matching the query regardless of pagination."}},"description":"A summary of List's locations.","title":"lists_list-locations_Response_200"},"30ListsListIdTagSearchGetResponsesContentApplicationJsonSchemaTagsItems":{"type":"object","properties":{"id":{"type":"integer","description":"The unique id for the tag."},"name":{"type":"string","description":"The name of the tag."}},"title":"30ListsListIdTagSearchGetResponsesContentApplicationJsonSchemaTagsItems"},"lists_list-tag-search_Response_200":{"type":"object","properties":{"tags":{"type":"array","items":{"$ref":"#/components/schemas/30ListsListIdTagSearchGetResponsesContentApplicationJsonSchemaTagsItems"},"description":"A list of matching tags."},"total_items":{"type":"integer","description":"The total number of items matching the query regardless of pagination."}},"description":"A list of tags matching the input query.","title":"lists_list-tag-search_Response_200"},"30ListsListIdSignupFormsGetResponsesContentApplicationJsonSchemaLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"30ListsListIdSignupFormsGetResponsesContentApplicationJsonSchemaLinksItemsMethod"},"30ListsListIdSignupFormsGetResponsesContentApplicationJsonSchemaLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/30ListsListIdSignupFormsGetResponsesContentApplicationJsonSchemaLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"30ListsListIdSignupFormsGetResponsesContentApplicationJsonSchemaLinksItems"},"SignupFormLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"SignupFormLinksItemsMethod"},"SignupFormLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/SignupFormLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"SignupFormLinksItems"},"SignupFormContentsItemsSection":{"type":"string","enum":["signup_message","unsub_message","signup_thank_you_title"],"description":"The content section name.","title":"SignupFormContentsItemsSection"},"SignupFormContentsItems":{"type":"object","properties":{"section":{"$ref":"#/components/schemas/SignupFormContentsItemsSection","description":"The content section name."},"value":{"type":"string","description":"The content section text."}},"description":"Collection of Content for List Signup Forms.","title":"SignupFormContentsItems"},"SignupFormHeaderImageAlign":{"type":"string","enum":["none","left","center","right"],"description":"Image alignment.","title":"SignupFormHeaderImageAlign"},"SignupFormHeaderImageBorderStyle":{"type":"string","enum":["none","solid","dotted","dashed","double","groove","outset","inset","ridge"],"description":"Image border style.","title":"SignupFormHeaderImageBorderStyle"},"SignupFormHeaderImageTarget":{"type":"string","enum":["_blank","null"],"description":"Image link target.","title":"SignupFormHeaderImageTarget"},"SignupFormHeader":{"type":"object","properties":{"image_align":{"$ref":"#/components/schemas/SignupFormHeaderImageAlign","description":"Image alignment."},"image_alt":{"type":"string","description":"Alt text for the image."},"image_border_color":{"type":"string","description":"Image border color."},"image_border_style":{"$ref":"#/components/schemas/SignupFormHeaderImageBorderStyle","description":"Image border style."},"image_border_width":{"type":"string","description":"Image border width."},"image_height":{"type":"string","description":"Image height, in pixels."},"image_link":{"type":"string","description":"The URL that the header image will link to."},"image_target":{"$ref":"#/components/schemas/SignupFormHeaderImageTarget","description":"Image link target."},"image_url":{"type":"string","description":"Header image URL."},"image_width":{"type":"string","description":"Image width, in pixels."},"text":{"type":"string","description":"Header text."}},"description":"Options for customizing your signup form header.","title":"SignupFormHeader"},"SignupFormStylesItemsOptionsItems":{"type":"object","properties":{"property":{"type":"string","description":"A string that identifies the property."},"value":{"type":"string","description":"A string that identifies value of the property."}},"description":"An option for Signup Form Styles.","title":"SignupFormStylesItemsOptionsItems"},"SignupFormStylesItemsSelector":{"type":"string","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"],"description":"A string that identifies the element selector.","title":"SignupFormStylesItemsSelector"},"SignupFormStylesItems":{"type":"object","properties":{"options":{"type":"array","items":{"$ref":"#/components/schemas/SignupFormStylesItemsOptionsItems"},"description":"A collection of options for a selector."},"selector":{"$ref":"#/components/schemas/SignupFormStylesItemsSelector","description":"A string that identifies the element selector."}},"description":"Collection of Element style for List Signup Forms.","title":"SignupFormStylesItems"},"SignupForm":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/SignupFormLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"contents":{"type":"array","items":{"$ref":"#/components/schemas/SignupFormContentsItems"},"description":"The signup form body content."},"header":{"$ref":"#/components/schemas/SignupFormHeader","description":"Options for customizing your signup form header."},"list_id":{"type":"string","description":"The signup form's list id."},"signup_form_url":{"type":"string","description":"Signup form URL."},"styles":{"type":"array","items":{"$ref":"#/components/schemas/SignupFormStylesItems"},"description":"An array of objects, each representing an element style for the signup form."}},"description":"List signup form.","title":"SignupForm"},"lists_list-signup-forms_Response_200":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/30ListsListIdSignupFormsGetResponsesContentApplicationJsonSchemaLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"list_id":{"type":"string","description":"The list id."},"signup_forms":{"type":"array","items":{"$ref":"#/components/schemas/SignupForm"},"description":"List signup form."},"total_items":{"type":"integer","description":"The total number of items matching the query regardless of pagination."}},"description":"List Signup Forms.","title":"lists_list-signup-forms_Response_200"},"30ListsListIdSignupFormsPostRequestBodyContentApplicationJsonSchemaContentsItemsSection":{"type":"string","enum":["signup_message","unsub_message","signup_thank_you_title"],"description":"The content section name.","title":"30ListsListIdSignupFormsPostRequestBodyContentApplicationJsonSchemaContentsItemsSection"},"30ListsListIdSignupFormsPostRequestBodyContentApplicationJsonSchemaContentsItems":{"type":"object","properties":{"section":{"$ref":"#/components/schemas/30ListsListIdSignupFormsPostRequestBodyContentApplicationJsonSchemaContentsItemsSection","description":"The content section name."},"value":{"type":"string","description":"The content section text."}},"description":"Collection of Content for List Signup Forms.","title":"30ListsListIdSignupFormsPostRequestBodyContentApplicationJsonSchemaContentsItems"},"30ListsListIdSignupFormsPostRequestBodyContentApplicationJsonSchemaHeaderImageAlign":{"type":"string","enum":["none","left","center","right"],"description":"Image alignment.","title":"30ListsListIdSignupFormsPostRequestBodyContentApplicationJsonSchemaHeaderImageAlign"},"30ListsListIdSignupFormsPostRequestBodyContentApplicationJsonSchemaHeaderImageBorderStyle":{"type":"string","enum":["none","solid","dotted","dashed","double","groove","outset","inset","ridge"],"description":"Image border style.","title":"30ListsListIdSignupFormsPostRequestBodyContentApplicationJsonSchemaHeaderImageBorderStyle"},"30ListsListIdSignupFormsPostRequestBodyContentApplicationJsonSchemaHeaderImageTarget":{"type":"string","enum":["_blank","null"],"description":"Image link target.","title":"30ListsListIdSignupFormsPostRequestBodyContentApplicationJsonSchemaHeaderImageTarget"},"30ListsListIdSignupFormsPostRequestBodyContentApplicationJsonSchemaHeader":{"type":"object","properties":{"image_align":{"$ref":"#/components/schemas/30ListsListIdSignupFormsPostRequestBodyContentApplicationJsonSchemaHeaderImageAlign","description":"Image alignment."},"image_alt":{"type":"string","description":"Alt text for the image."},"image_border_color":{"type":"string","description":"Image border color."},"image_border_style":{"$ref":"#/components/schemas/30ListsListIdSignupFormsPostRequestBodyContentApplicationJsonSchemaHeaderImageBorderStyle","description":"Image border style."},"image_border_width":{"type":"string","description":"Image border width."},"image_height":{"type":"string","description":"Image height, in pixels."},"image_link":{"type":"string","description":"The URL that the header image will link to."},"image_target":{"$ref":"#/components/schemas/30ListsListIdSignupFormsPostRequestBodyContentApplicationJsonSchemaHeaderImageTarget","description":"Image link target."},"image_url":{"type":"string","description":"Header image URL."},"image_width":{"type":"string","description":"Image width, in pixels."},"text":{"type":"string","description":"Header text."}},"description":"Options for customizing your signup form header.","title":"30ListsListIdSignupFormsPostRequestBodyContentApplicationJsonSchemaHeader"},"30ListsListIdSignupFormsPostRequestBodyContentApplicationJsonSchemaStylesItemsOptionsItems":{"type":"object","properties":{"property":{"type":"string","description":"A string that identifies the property."},"value":{"type":"string","description":"A string that identifies value of the property."}},"description":"An option for Signup Form Styles.","title":"30ListsListIdSignupFormsPostRequestBodyContentApplicationJsonSchemaStylesItemsOptionsItems"},"30ListsListIdSignupFormsPostRequestBodyContentApplicationJsonSchemaStylesItemsSelector":{"type":"string","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"],"description":"A string that identifies the element selector.","title":"30ListsListIdSignupFormsPostRequestBodyContentApplicationJsonSchemaStylesItemsSelector"},"30ListsListIdSignupFormsPostRequestBodyContentApplicationJsonSchemaStylesItems":{"type":"object","properties":{"options":{"type":"array","items":{"$ref":"#/components/schemas/30ListsListIdSignupFormsPostRequestBodyContentApplicationJsonSchemaStylesItemsOptionsItems"},"description":"A collection of options for a selector."},"selector":{"$ref":"#/components/schemas/30ListsListIdSignupFormsPostRequestBodyContentApplicationJsonSchemaStylesItemsSelector","description":"A string that identifies the element selector."}},"description":"Collection of Element style for List Signup Forms.","title":"30ListsListIdSignupFormsPostRequestBodyContentApplicationJsonSchemaStylesItems"},"30ListsListIdAbuseReportsGetResponsesContentApplicationJsonSchemaLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"30ListsListIdAbuseReportsGetResponsesContentApplicationJsonSchemaLinksItemsMethod"},"30ListsListIdAbuseReportsGetResponsesContentApplicationJsonSchemaLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/30ListsListIdAbuseReportsGetResponsesContentApplicationJsonSchemaLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"30ListsListIdAbuseReportsGetResponsesContentApplicationJsonSchemaLinksItems"},"ListsAbuseReportsLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"ListsAbuseReportsLinksItemsMethod"},"ListsAbuseReportsLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/ListsAbuseReportsLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"ListsAbuseReportsLinksItems"},"ListsAbuseReportsMergeFields0":{"type":"object","properties":{"addr1":{"type":"string"},"addr2":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"zip":{"type":"string"},"country":{"type":"string"}},"required":["addr1","city","state","zip"],"title":"ListsAbuseReportsMergeFields0"},"ListsAbuseReportsMergeFields":{"oneOf":[{"$ref":"#/components/schemas/ListsAbuseReportsMergeFields0"},{"type":"string"},{"type":"number","format":"double"}],"description":"This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field.","title":"ListsAbuseReportsMergeFields"},"ListsAbuseReports":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/ListsAbuseReportsLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"campaign_id":{"type":"string","description":"The campaign id for the abuse report"},"date":{"type":"string","description":"Date for the abuse report"},"email_address":{"type":"string","description":"Email address for a subscriber."},"email_id":{"type":"string","description":"The MD5 hash of the lowercase version of the list member's email address."},"id":{"type":"integer","description":"The id for the abuse report"},"list_id":{"type":"string","description":"The list id for the abuse report."},"merge_fields":{"type":["object","null"],"additionalProperties":{"$ref":"#/components/schemas/ListsAbuseReportsMergeFields"},"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."},"vip":{"type":"boolean","description":"[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber."}},"description":"Details of abuse complaints for a specific list. An abuse complaint occurs when your recipient clicks to 'report spam' in their email program.","title":"ListsAbuseReports"},"lists_list-abuse-reports_Response_200":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/30ListsListIdAbuseReportsGetResponsesContentApplicationJsonSchemaLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"abuse_reports":{"type":"array","items":{"$ref":"#/components/schemas/ListsAbuseReports"},"description":"An array of objects, each representing an abuse report resource."},"list_id":{"type":"string","description":"The list id for the abuse report."},"total_items":{"type":"integer","description":"The total number of items matching the query regardless of pagination."}},"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.","title":"lists_list-abuse-reports_Response_200"},"30ListsListIdInterestCategoriesGetParametersSortField":{"type":"string","enum":["name","display_order"],"title":"30ListsListIdInterestCategoriesGetParametersSortField"},"30ListsListIdInterestCategoriesGetParametersSortDir":{"type":"string","enum":["ASC","DESC"],"title":"30ListsListIdInterestCategoriesGetParametersSortDir"},"30ListsListIdInterestCategoriesGetResponsesContentApplicationJsonSchemaLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"30ListsListIdInterestCategoriesGetResponsesContentApplicationJsonSchemaLinksItemsMethod"},"30ListsListIdInterestCategoriesGetResponsesContentApplicationJsonSchemaLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/30ListsListIdInterestCategoriesGetResponsesContentApplicationJsonSchemaLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"30ListsListIdInterestCategoriesGetResponsesContentApplicationJsonSchemaLinksItems"},"InterestCategoryLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"InterestCategoryLinksItemsMethod"},"InterestCategoryLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/InterestCategoryLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"InterestCategoryLinksItems"},"InterestCategoryType":{"type":"string","enum":["checkboxes","dropdown","radio","hidden"],"description":"Determines how this category’s interests appear on signup forms.","title":"InterestCategoryType"},"InterestCategory":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/InterestCategoryLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"display_order":{"type":"integer","description":"The order that the categories are displayed in the list. Lower numbers display first."},"id":{"type":"string","description":"The id for the interest category."},"list_id":{"type":"string","description":"The unique list id for the category."},"title":{"type":"string","description":"The text description of this category. This field appears on signup forms and is often phrased as a question."},"type":{"$ref":"#/components/schemas/InterestCategoryType","description":"Determines how this category’s interests appear on signup forms."}},"description":"Interest categories organize interests, which are used to group subscribers based on their preferences. These correspond to Group Titles the application.","title":"InterestCategory"},"lists_list-interest-categories_Response_200":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/30ListsListIdInterestCategoriesGetResponsesContentApplicationJsonSchemaLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"categories":{"type":"array","items":{"$ref":"#/components/schemas/InterestCategory"},"description":"This array contains individual interest categories."},"list_id":{"type":"string","description":"The ID for the list that this category belongs to."},"total_items":{"type":"integer","description":"The total number of items matching the query regardless of pagination."}},"description":"Information about this list's interest categories.","title":"lists_list-interest-categories_Response_200"},"30ListsListIdInterestCategoriesPostRequestBodyContentApplicationJsonSchemaType":{"type":"string","enum":["checkboxes","dropdown","radio","hidden"],"description":"Determines how this category’s interests appear on signup forms.","title":"30ListsListIdInterestCategoriesPostRequestBodyContentApplicationJsonSchemaType"},"30ListsListIdInterestCategoriesInterestCategoryIdPatchRequestBodyContentApplicationJsonSchemaType":{"type":"string","enum":["checkboxes","dropdown","radio","hidden"],"description":"Determines how this category’s interests appear on signup forms.","title":"30ListsListIdInterestCategoriesInterestCategoryIdPatchRequestBodyContentApplicationJsonSchemaType"},"30ListsListIdInterestCategoriesInterestCategoryIdInterestsGetResponsesContentApplicationJsonSchemaLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"30ListsListIdInterestCategoriesInterestCategoryIdInterestsGetResponsesContentApplicationJsonSchemaLinksItemsMethod"},"30ListsListIdInterestCategoriesInterestCategoryIdInterestsGetResponsesContentApplicationJsonSchemaLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/30ListsListIdInterestCategoriesInterestCategoryIdInterestsGetResponsesContentApplicationJsonSchemaLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"30ListsListIdInterestCategoriesInterestCategoryIdInterestsGetResponsesContentApplicationJsonSchemaLinksItems"},"InterestLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"InterestLinksItemsMethod"},"InterestLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/InterestLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"InterestLinksItems"},"Interest":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/InterestLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"category_id":{"type":"string","description":"The id for the interest category."},"display_order":{"type":"integer","description":"The display order for interests."},"id":{"type":"string","description":"The ID for the interest."},"list_id":{"type":"string","description":"The ID for the list that this interest belongs to."},"name":{"type":"string","description":"The name of the interest. This can be shown publicly on a subscription form."},"subscriber_count":{"type":"string","description":"The number of subscribers associated with this interest."}},"description":"Assign subscribers to interests to group them together. Interests are referred to as 'group names' in the Mailchimp application.","title":"Interest"},"lists_list-interest-category-interests_Response_200":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/30ListsListIdInterestCategoriesInterestCategoryIdInterestsGetResponsesContentApplicationJsonSchemaLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"category_id":{"type":"string","description":"The id for the interest category."},"interests":{"type":"array","items":{"$ref":"#/components/schemas/Interest"},"description":"An array of this category's interests"},"list_id":{"type":"string","description":"The unique list id that the interests belong to."},"total_items":{"type":"integer","description":"The total number of items matching the query regardless of pagination."}},"description":"A list of this category's interests","title":"lists_list-interest-category-interests_Response_200"},"30ListsListIdMembersGetParametersStatus":{"type":"string","enum":["subscribed","unsubscribed","cleaned","pending","transactional","archived"],"title":"30ListsListIdMembersGetParametersStatus"},"30ListsListIdMembersGetParametersInterestMatch":{"type":"string","enum":["any","all","none"],"title":"30ListsListIdMembersGetParametersInterestMatch"},"30ListsListIdMembersGetParametersSortField":{"type":"string","enum":["timestamp_opt","timestamp_signup","last_changed"],"title":"30ListsListIdMembersGetParametersSortField"},"30ListsListIdMembersGetParametersSortDir":{"type":"string","enum":["ASC","DESC"],"title":"30ListsListIdMembersGetParametersSortDir"},"30ListsListIdMembersGetResponsesContentApplicationJsonSchemaLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"30ListsListIdMembersGetResponsesContentApplicationJsonSchemaLinksItemsMethod"},"30ListsListIdMembersGetResponsesContentApplicationJsonSchemaLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/30ListsListIdMembersGetResponsesContentApplicationJsonSchemaLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"30ListsListIdMembersGetResponsesContentApplicationJsonSchemaLinksItems"},"ListMembersLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"ListMembersLinksItemsMethod"},"ListMembersLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/ListMembersLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"ListMembersLinksItems"},"ListMembersLastNote":{"type":"object","properties":{"created_at":{"type":"string","format":"date-time","description":"The date and time the note was created in ISO 8601 format."},"created_by":{"type":"string","description":"The author of the note."},"note":{"type":"string","description":"The content of the note."},"note_id":{"type":"integer","description":"The note id."}},"description":"The most recent Note added about this member.","title":"ListMembersLastNote"},"ListMembersLocation":{"type":"object","properties":{"country_code":{"type":"string","description":"The unique code for the location country."},"dstoff":{"type":"integer","description":"The offset for timezones where daylight saving time is observed."},"gmtoff":{"type":"integer","description":"The time difference in hours from GMT."},"latitude":{"type":"number","format":"double","description":"The location latitude."},"longitude":{"type":"number","format":"double","description":"The location longitude."},"region":{"type":"string","description":"The region for the location."},"timezone":{"type":"string","description":"The timezone for the location."}},"description":"Subscriber location information.","title":"ListMembersLocation"},"ListMembersMarketingPermissionsItems":{"type":"object","properties":{"enabled":{"type":"boolean","description":"If the subscriber has opted-in to the marketing permission."},"marketing_permission_id":{"type":"string","description":"The id for the marketing permission on the list"},"text":{"type":"string","description":"The text of the marketing permission."}},"description":"A single marketing permission a subscriber has either opted-in to or opted-out of.","title":"ListMembersMarketingPermissionsItems"},"ListMembersMergeFields0":{"type":"object","properties":{"addr1":{"type":"string"},"addr2":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"zip":{"type":"string"},"country":{"type":"string"}},"required":["addr1","city","state","zip"],"title":"ListMembersMergeFields0"},"ListMembersMergeFields":{"oneOf":[{"$ref":"#/components/schemas/ListMembersMergeFields0"},{"type":"string"},{"type":"number","format":"double"}],"description":"This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field.","title":"ListMembersMergeFields"},"ListMembersSmsSubscriptionStatus":{"type":"string","enum":["subscribed","unsubscribed","nonsubscribed","pending"],"description":"The status of an SMS subscription.","title":"ListMembersSmsSubscriptionStatus"},"ListMembersStatsEcommerceData":{"type":"object","properties":{"currency_code":{"type":"string","description":"The three-letter ISO 4217 code for the currency that the store accepts."},"number_of_orders":{"type":"number","format":"double","description":"The total number of orders placed by the list member."},"total_revenue":{"type":"number","format":"double","description":"The total revenue the list member has brought in."}},"description":"Ecommerce stats for the list member if the list is attached to a store.","title":"ListMembersStatsEcommerceData"},"ListMembersStats":{"type":"object","properties":{"avg_click_rate":{"type":"number","format":"double","description":"A subscriber's average clickthrough rate."},"avg_open_rate":{"type":"number","format":"double","description":"A subscriber's average open rate."},"ecommerce_data":{"$ref":"#/components/schemas/ListMembersStatsEcommerceData","description":"Ecommerce stats for the list member if the list is attached to a store."}},"description":"Open and click rates for this subscriber.","title":"ListMembersStats"},"ListMembersStatus":{"type":"string","enum":["subscribed","unsubscribed","cleaned","pending","transactional","archived"],"description":"Subscriber's current status.","title":"ListMembersStatus"},"ListMembersTagsItems":{"type":"object","properties":{"id":{"type":"integer","description":"The tag id."},"name":{"type":"string","description":"The name of the tag"}},"title":"ListMembersTagsItems"},"ListMembers":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/ListMembersLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"consents_to_one_to_one_messaging":{"type":"boolean","description":"Indicates whether a contact consents to 1:1 messaging."},"contact_id":{"type":"string","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."},"email_address":{"type":"string","description":"Email address for a subscriber."},"email_client":{"type":"string","description":"The list member's email client."},"email_type":{"description":"Type of email this member asked to get ('html' or 'text')."},"id":{"type":"string","description":"The MD5 hash of the lowercase version of the list member's email address."},"interests":{"type":"object","additionalProperties":{"type":"boolean"},"description":"The key of this object's properties is the ID of the interest in question."},"ip_opt":{"type":"string","description":"The IP address the subscriber used to confirm their opt-in status."},"ip_signup":{"type":"string","description":"IP address the subscriber signed up from."},"language":{"type":"string","description":"If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/)."},"last_changed":{"type":"string","format":"date-time","description":"The date and time the member's info was last changed in ISO 8601 format."},"last_note":{"$ref":"#/components/schemas/ListMembersLastNote","description":"The most recent Note added about this member."},"list_id":{"type":"string","description":"The list id."},"location":{"$ref":"#/components/schemas/ListMembersLocation","description":"Subscriber location information."},"marketing_permissions":{"type":"array","items":{"$ref":"#/components/schemas/ListMembersMarketingPermissionsItems"},"description":"The marketing permissions for the subscriber."},"member_rating":{"type":"integer","description":"Star rating for this member, between 1 and 5."},"merge_fields":{"type":["object","null"],"additionalProperties":{"$ref":"#/components/schemas/ListMembersMergeFields"},"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."},"sms_phone_number":{"type":"string","description":"A US phone number for SMS contact."},"sms_subscription_last_updated":{"type":"string","description":"The datetime when the SMS subscription was last updated"},"sms_subscription_status":{"$ref":"#/components/schemas/ListMembersSmsSubscriptionStatus","description":"The status of an SMS subscription."},"source":{"type":"string","description":"The source from which the subscriber was added to this list."},"stats":{"$ref":"#/components/schemas/ListMembersStats","description":"Open and click rates for this subscriber."},"status":{"$ref":"#/components/schemas/ListMembersStatus","description":"Subscriber's current status."},"tags":{"type":"array","items":{"$ref":"#/components/schemas/ListMembersTagsItems"},"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/)."},"tags_count":{"type":"integer","description":"The number of tags applied to this member."},"timestamp_opt":{"type":"string","format":"date-time","description":"The date and time the subscriber confirmed their opt-in status in ISO 8601 format."},"timestamp_signup":{"type":"string","format":"date-time","description":"The date and time the subscriber signed up for the list in ISO 8601 format."},"unique_email_id":{"type":"string","description":"An identifier for the address across all of Mailchimp."},"unsubscribe_reason":{"type":"string","description":"A subscriber's reason for unsubscribing."},"vip":{"type":"boolean","description":"[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber."},"web_id":{"type":"integer","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}`."}},"description":"Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed.","title":"ListMembers"},"lists_list-members_Response_200":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/30ListsListIdMembersGetResponsesContentApplicationJsonSchemaLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"list_id":{"type":"string","description":"The list id."},"members":{"type":"array","items":{"$ref":"#/components/schemas/ListMembers"},"description":"An array of objects, each representing a specific list member."},"total_items":{"type":"integer","description":"The total number of items matching the query regardless of pagination."}},"description":"Manage members of a specific Mailchimp list, including currently subscribed, unsubscribed, and bounced members.","title":"lists_list-members_Response_200"},"30ListsListIdMembersPostRequestBodyContentApplicationJsonSchemaLocationLatitude":{"oneOf":[{"type":"number","format":"double"},{"type":"string","pattern":"^\\s*[+-]?(?:[0-9]+\\.?[0-9]*|\\.[0-9]+)(?:[eE][+-]?[0-9]+)?\\s*$"}],"title":"30ListsListIdMembersPostRequestBodyContentApplicationJsonSchemaLocationLatitude"},"30ListsListIdMembersPostRequestBodyContentApplicationJsonSchemaLocationLongitude":{"oneOf":[{"type":"number","format":"double"},{"type":"string","pattern":"^\\s*[+-]?(?:[0-9]+\\.?[0-9]*|\\.[0-9]+)(?:[eE][+-]?[0-9]+)?\\s*$"}],"title":"30ListsListIdMembersPostRequestBodyContentApplicationJsonSchemaLocationLongitude"},"30ListsListIdMembersPostRequestBodyContentApplicationJsonSchemaLocation":{"type":"object","properties":{"latitude":{"$ref":"#/components/schemas/30ListsListIdMembersPostRequestBodyContentApplicationJsonSchemaLocationLatitude"},"longitude":{"$ref":"#/components/schemas/30ListsListIdMembersPostRequestBodyContentApplicationJsonSchemaLocationLongitude"}},"description":"Subscriber location information.","title":"30ListsListIdMembersPostRequestBodyContentApplicationJsonSchemaLocation"},"30ListsListIdMembersPostRequestBodyContentApplicationJsonSchemaMarketingPermissionsItems":{"type":"object","properties":{"enabled":{"type":"boolean","description":"If the subscriber has opted-in to the marketing permission."},"marketing_permission_id":{"type":"string","description":"The id for the marketing permission on the list"}},"description":"A single marketing permission a subscriber has either opted-in to or opted-out of.","title":"30ListsListIdMembersPostRequestBodyContentApplicationJsonSchemaMarketingPermissionsItems"},"30ListsListIdMembersPostRequestBodyContentApplicationJsonSchemaMergeFields0":{"type":"object","properties":{"addr1":{"type":"string"},"addr2":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"zip":{"type":"string"},"country":{"type":"string"}},"required":["addr1","city","state","zip"],"title":"30ListsListIdMembersPostRequestBodyContentApplicationJsonSchemaMergeFields0"},"30ListsListIdMembersPostRequestBodyContentApplicationJsonSchemaMergeFields":{"oneOf":[{"$ref":"#/components/schemas/30ListsListIdMembersPostRequestBodyContentApplicationJsonSchemaMergeFields0"},{"type":"string"},{"type":"number","format":"double"}],"description":"This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field.","title":"30ListsListIdMembersPostRequestBodyContentApplicationJsonSchemaMergeFields"},"30ListsListIdMembersPostRequestBodyContentApplicationJsonSchemaStatus":{"type":"string","enum":["subscribed","unsubscribed","cleaned","pending","transactional"],"description":"Subscriber's current status.","title":"30ListsListIdMembersPostRequestBodyContentApplicationJsonSchemaStatus"},"30ListsListIdMembersPostRequestBodyContentApplicationJsonSchemaTimestampOpt0":{"oneOf":[{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(Z|[+-]\\d{2}:?\\d{2})$"}],"description":"Matches MC\\API30\\RequestModels\\Constraints\\TwoFormatDateTime, which accepts either 'Y-m-d H:i:s' or ISO 8601 with an offset.","title":"30ListsListIdMembersPostRequestBodyContentApplicationJsonSchemaTimestampOpt0"},"30ListsListIdMembersPostRequestBodyContentApplicationJsonSchemaTimestampOpt1":{"type":"string","enum":[""],"title":"30ListsListIdMembersPostRequestBodyContentApplicationJsonSchemaTimestampOpt1"},"30ListsListIdMembersPostRequestBodyContentApplicationJsonSchemaTimestampOpt":{"oneOf":[{"$ref":"#/components/schemas/30ListsListIdMembersPostRequestBodyContentApplicationJsonSchemaTimestampOpt0"},{"$ref":"#/components/schemas/30ListsListIdMembersPostRequestBodyContentApplicationJsonSchemaTimestampOpt1"}],"title":"30ListsListIdMembersPostRequestBodyContentApplicationJsonSchemaTimestampOpt"},"30ListsListIdMembersPostRequestBodyContentApplicationJsonSchemaTimestampSignup0":{"oneOf":[{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(Z|[+-]\\d{2}:?\\d{2})$"}],"description":"Matches MC\\API30\\RequestModels\\Constraints\\TwoFormatDateTime, which accepts either 'Y-m-d H:i:s' or ISO 8601 with an offset.","title":"30ListsListIdMembersPostRequestBodyContentApplicationJsonSchemaTimestampSignup0"},"30ListsListIdMembersPostRequestBodyContentApplicationJsonSchemaTimestampSignup1":{"type":"string","enum":[""],"title":"30ListsListIdMembersPostRequestBodyContentApplicationJsonSchemaTimestampSignup1"},"30ListsListIdMembersPostRequestBodyContentApplicationJsonSchemaTimestampSignup":{"oneOf":[{"$ref":"#/components/schemas/30ListsListIdMembersPostRequestBodyContentApplicationJsonSchemaTimestampSignup0"},{"$ref":"#/components/schemas/30ListsListIdMembersPostRequestBodyContentApplicationJsonSchemaTimestampSignup1"}],"title":"30ListsListIdMembersPostRequestBodyContentApplicationJsonSchemaTimestampSignup"},"30ListsListIdMembersSubscriberHashPatchRequestBodyContentApplicationJsonSchemaLocationLatitude":{"oneOf":[{"type":"number","format":"double"},{"type":"string","pattern":"^\\s*[+-]?(?:[0-9]+\\.?[0-9]*|\\.[0-9]+)(?:[eE][+-]?[0-9]+)?\\s*$"}],"title":"30ListsListIdMembersSubscriberHashPatchRequestBodyContentApplicationJsonSchemaLocationLatitude"},"30ListsListIdMembersSubscriberHashPatchRequestBodyContentApplicationJsonSchemaLocationLongitude":{"oneOf":[{"type":"number","format":"double"},{"type":"string","pattern":"^\\s*[+-]?(?:[0-9]+\\.?[0-9]*|\\.[0-9]+)(?:[eE][+-]?[0-9]+)?\\s*$"}],"title":"30ListsListIdMembersSubscriberHashPatchRequestBodyContentApplicationJsonSchemaLocationLongitude"},"30ListsListIdMembersSubscriberHashPatchRequestBodyContentApplicationJsonSchemaLocation":{"type":"object","properties":{"latitude":{"$ref":"#/components/schemas/30ListsListIdMembersSubscriberHashPatchRequestBodyContentApplicationJsonSchemaLocationLatitude"},"longitude":{"$ref":"#/components/schemas/30ListsListIdMembersSubscriberHashPatchRequestBodyContentApplicationJsonSchemaLocationLongitude"}},"description":"Subscriber location information.","title":"30ListsListIdMembersSubscriberHashPatchRequestBodyContentApplicationJsonSchemaLocation"},"30ListsListIdMembersSubscriberHashPatchRequestBodyContentApplicationJsonSchemaMarketingPermissionsItems":{"type":"object","properties":{"enabled":{"type":"boolean","description":"If the subscriber has opted-in to the marketing permission."},"marketing_permission_id":{"type":"string","description":"The id for the marketing permission on the list"}},"description":"A single marketing permission a subscriber has either opted-in to or opted-out of.","title":"30ListsListIdMembersSubscriberHashPatchRequestBodyContentApplicationJsonSchemaMarketingPermissionsItems"},"30ListsListIdMembersSubscriberHashPatchRequestBodyContentApplicationJsonSchemaMergeFields0":{"type":"object","properties":{"addr1":{"type":"string"},"addr2":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"zip":{"type":"string"},"country":{"type":"string"}},"required":["addr1","city","state","zip"],"title":"30ListsListIdMembersSubscriberHashPatchRequestBodyContentApplicationJsonSchemaMergeFields0"},"30ListsListIdMembersSubscriberHashPatchRequestBodyContentApplicationJsonSchemaMergeFields":{"oneOf":[{"$ref":"#/components/schemas/30ListsListIdMembersSubscriberHashPatchRequestBodyContentApplicationJsonSchemaMergeFields0"},{"type":"string"},{"type":"number","format":"double"}],"description":"This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field.","title":"30ListsListIdMembersSubscriberHashPatchRequestBodyContentApplicationJsonSchemaMergeFields"},"30ListsListIdMembersSubscriberHashPatchRequestBodyContentApplicationJsonSchemaStatus":{"type":"string","enum":["subscribed","unsubscribed","cleaned","pending","transactional"],"description":"Subscriber's current status.","title":"30ListsListIdMembersSubscriberHashPatchRequestBodyContentApplicationJsonSchemaStatus"},"30ListsListIdMembersSubscriberHashPatchRequestBodyContentApplicationJsonSchemaTimestampOpt0":{"oneOf":[{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(Z|[+-]\\d{2}:?\\d{2})$"}],"description":"Matches MC\\API30\\RequestModels\\Constraints\\TwoFormatDateTime, which accepts either 'Y-m-d H:i:s' or ISO 8601 with an offset.","title":"30ListsListIdMembersSubscriberHashPatchRequestBodyContentApplicationJsonSchemaTimestampOpt0"},"30ListsListIdMembersSubscriberHashPatchRequestBodyContentApplicationJsonSchemaTimestampOpt1":{"type":"string","enum":[""],"title":"30ListsListIdMembersSubscriberHashPatchRequestBodyContentApplicationJsonSchemaTimestampOpt1"},"30ListsListIdMembersSubscriberHashPatchRequestBodyContentApplicationJsonSchemaTimestampOpt":{"oneOf":[{"$ref":"#/components/schemas/30ListsListIdMembersSubscriberHashPatchRequestBodyContentApplicationJsonSchemaTimestampOpt0"},{"$ref":"#/components/schemas/30ListsListIdMembersSubscriberHashPatchRequestBodyContentApplicationJsonSchemaTimestampOpt1"}],"title":"30ListsListIdMembersSubscriberHashPatchRequestBodyContentApplicationJsonSchemaTimestampOpt"},"30ListsListIdMembersSubscriberHashPatchRequestBodyContentApplicationJsonSchemaTimestampSignup0":{"oneOf":[{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(Z|[+-]\\d{2}:?\\d{2})$"}],"description":"Matches MC\\API30\\RequestModels\\Constraints\\TwoFormatDateTime, which accepts either 'Y-m-d H:i:s' or ISO 8601 with an offset.","title":"30ListsListIdMembersSubscriberHashPatchRequestBodyContentApplicationJsonSchemaTimestampSignup0"},"30ListsListIdMembersSubscriberHashPatchRequestBodyContentApplicationJsonSchemaTimestampSignup1":{"type":"string","enum":[""],"title":"30ListsListIdMembersSubscriberHashPatchRequestBodyContentApplicationJsonSchemaTimestampSignup1"},"30ListsListIdMembersSubscriberHashPatchRequestBodyContentApplicationJsonSchemaTimestampSignup":{"oneOf":[{"$ref":"#/components/schemas/30ListsListIdMembersSubscriberHashPatchRequestBodyContentApplicationJsonSchemaTimestampSignup0"},{"$ref":"#/components/schemas/30ListsListIdMembersSubscriberHashPatchRequestBodyContentApplicationJsonSchemaTimestampSignup1"}],"title":"30ListsListIdMembersSubscriberHashPatchRequestBodyContentApplicationJsonSchemaTimestampSignup"},"30ListsListIdMembersSubscriberHashPutRequestBodyContentApplicationJsonSchemaLocationLatitude":{"oneOf":[{"type":"number","format":"double"},{"type":"string","pattern":"^\\s*[+-]?(?:[0-9]+\\.?[0-9]*|\\.[0-9]+)(?:[eE][+-]?[0-9]+)?\\s*$"}],"title":"30ListsListIdMembersSubscriberHashPutRequestBodyContentApplicationJsonSchemaLocationLatitude"},"30ListsListIdMembersSubscriberHashPutRequestBodyContentApplicationJsonSchemaLocationLongitude":{"oneOf":[{"type":"number","format":"double"},{"type":"string","pattern":"^\\s*[+-]?(?:[0-9]+\\.?[0-9]*|\\.[0-9]+)(?:[eE][+-]?[0-9]+)?\\s*$"}],"title":"30ListsListIdMembersSubscriberHashPutRequestBodyContentApplicationJsonSchemaLocationLongitude"},"30ListsListIdMembersSubscriberHashPutRequestBodyContentApplicationJsonSchemaLocation":{"type":"object","properties":{"latitude":{"$ref":"#/components/schemas/30ListsListIdMembersSubscriberHashPutRequestBodyContentApplicationJsonSchemaLocationLatitude"},"longitude":{"$ref":"#/components/schemas/30ListsListIdMembersSubscriberHashPutRequestBodyContentApplicationJsonSchemaLocationLongitude"}},"description":"Subscriber location information.","title":"30ListsListIdMembersSubscriberHashPutRequestBodyContentApplicationJsonSchemaLocation"},"30ListsListIdMembersSubscriberHashPutRequestBodyContentApplicationJsonSchemaMarketingPermissionsItems":{"type":"object","properties":{"enabled":{"type":"boolean","description":"If the subscriber has opted-in to the marketing permission."},"marketing_permission_id":{"type":"string","description":"The id for the marketing permission on the list"}},"description":"A single marketing permission a subscriber has either opted-in to or opted-out of.","title":"30ListsListIdMembersSubscriberHashPutRequestBodyContentApplicationJsonSchemaMarketingPermissionsItems"},"30ListsListIdMembersSubscriberHashPutRequestBodyContentApplicationJsonSchemaMergeFields0":{"type":"object","properties":{"addr1":{"type":"string"},"addr2":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"zip":{"type":"string"},"country":{"type":"string"}},"required":["addr1","city","state","zip"],"title":"30ListsListIdMembersSubscriberHashPutRequestBodyContentApplicationJsonSchemaMergeFields0"},"30ListsListIdMembersSubscriberHashPutRequestBodyContentApplicationJsonSchemaMergeFields":{"oneOf":[{"$ref":"#/components/schemas/30ListsListIdMembersSubscriberHashPutRequestBodyContentApplicationJsonSchemaMergeFields0"},{"type":"string"},{"type":"number","format":"double"}],"description":"This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field.","title":"30ListsListIdMembersSubscriberHashPutRequestBodyContentApplicationJsonSchemaMergeFields"},"30ListsListIdMembersSubscriberHashPutRequestBodyContentApplicationJsonSchemaStatus":{"type":"string","enum":["subscribed","unsubscribed","cleaned","pending","transactional"],"description":"Subscriber's current status.","title":"30ListsListIdMembersSubscriberHashPutRequestBodyContentApplicationJsonSchemaStatus"},"30ListsListIdMembersSubscriberHashPutRequestBodyContentApplicationJsonSchemaStatusIfNew":{"type":"string","enum":["subscribed","unsubscribed","cleaned","pending","transactional"],"description":"Subscriber's status. This value is required only if the email address is not already present on the list.","title":"30ListsListIdMembersSubscriberHashPutRequestBodyContentApplicationJsonSchemaStatusIfNew"},"30ListsListIdMembersSubscriberHashPutRequestBodyContentApplicationJsonSchemaTimestampOpt0":{"oneOf":[{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(Z|[+-]\\d{2}:?\\d{2})$"}],"description":"Matches MC\\API30\\RequestModels\\Constraints\\TwoFormatDateTime, which accepts either 'Y-m-d H:i:s' or ISO 8601 with an offset.","title":"30ListsListIdMembersSubscriberHashPutRequestBodyContentApplicationJsonSchemaTimestampOpt0"},"30ListsListIdMembersSubscriberHashPutRequestBodyContentApplicationJsonSchemaTimestampOpt1":{"type":"string","enum":[""],"title":"30ListsListIdMembersSubscriberHashPutRequestBodyContentApplicationJsonSchemaTimestampOpt1"},"30ListsListIdMembersSubscriberHashPutRequestBodyContentApplicationJsonSchemaTimestampOpt":{"oneOf":[{"$ref":"#/components/schemas/30ListsListIdMembersSubscriberHashPutRequestBodyContentApplicationJsonSchemaTimestampOpt0"},{"$ref":"#/components/schemas/30ListsListIdMembersSubscriberHashPutRequestBodyContentApplicationJsonSchemaTimestampOpt1"}],"title":"30ListsListIdMembersSubscriberHashPutRequestBodyContentApplicationJsonSchemaTimestampOpt"},"30ListsListIdMembersSubscriberHashPutRequestBodyContentApplicationJsonSchemaTimestampSignup0":{"oneOf":[{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$"},{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(Z|[+-]\\d{2}:?\\d{2})$"}],"description":"Matches MC\\API30\\RequestModels\\Constraints\\TwoFormatDateTime, which accepts either 'Y-m-d H:i:s' or ISO 8601 with an offset.","title":"30ListsListIdMembersSubscriberHashPutRequestBodyContentApplicationJsonSchemaTimestampSignup0"},"30ListsListIdMembersSubscriberHashPutRequestBodyContentApplicationJsonSchemaTimestampSignup1":{"type":"string","enum":[""],"title":"30ListsListIdMembersSubscriberHashPutRequestBodyContentApplicationJsonSchemaTimestampSignup1"},"30ListsListIdMembersSubscriberHashPutRequestBodyContentApplicationJsonSchemaTimestampSignup":{"oneOf":[{"$ref":"#/components/schemas/30ListsListIdMembersSubscriberHashPutRequestBodyContentApplicationJsonSchemaTimestampSignup0"},{"$ref":"#/components/schemas/30ListsListIdMembersSubscriberHashPutRequestBodyContentApplicationJsonSchemaTimestampSignup1"}],"title":"30ListsListIdMembersSubscriberHashPutRequestBodyContentApplicationJsonSchemaTimestampSignup"},"30ListsListIdMembersSubscriberHashActivityGetParametersActionSchemaItems":{"type":"string","enum":["abuse","bounce","click","open","sent","unsub","ecomm"],"title":"30ListsListIdMembersSubscriberHashActivityGetParametersActionSchemaItems"},"30ListsListIdMembersSubscriberHashActivityGetResponsesContentApplicationJsonSchemaLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"30ListsListIdMembersSubscriberHashActivityGetResponsesContentApplicationJsonSchemaLinksItemsMethod"},"30ListsListIdMembersSubscriberHashActivityGetResponsesContentApplicationJsonSchemaLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/30ListsListIdMembersSubscriberHashActivityGetResponsesContentApplicationJsonSchemaLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"30ListsListIdMembersSubscriberHashActivityGetResponsesContentApplicationJsonSchemaLinksItems"},"30ListsListIdMembersSubscriberHashActivityGetResponsesContentApplicationJsonSchemaActivityItems":{"type":"object","properties":{"action":{"type":"string","description":"The type of action recorded for the subscriber."},"campaign_id":{"type":"string","description":"The web-based ID for the campaign."},"parent_campaign":{"type":"string","description":"The ID of the parent campaign."},"timestamp":{"type":"string","format":"date-time","description":"The date and time recorded for the action."},"title":{"type":"string","description":"If set, the campaign's title."},"type":{"type":"string","description":"The type of campaign that was sent."},"url":{"type":"string","description":"For clicks, the URL the subscriber clicked on."}},"description":"Member activity events.","title":"30ListsListIdMembersSubscriberHashActivityGetResponsesContentApplicationJsonSchemaActivityItems"},"lists_list-member-activity_Response_200":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/30ListsListIdMembersSubscriberHashActivityGetResponsesContentApplicationJsonSchemaLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"activity":{"type":"array","items":{"$ref":"#/components/schemas/30ListsListIdMembersSubscriberHashActivityGetResponsesContentApplicationJsonSchemaActivityItems"},"description":"An array of objects, each representing a member event."},"contact_id":{"type":"string","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."},"email_id":{"type":"string","description":"The MD5 hash of the lowercase version of the list member's email address."},"list_id":{"type":"string","description":"The list id."},"total_items":{"type":"integer","description":"The total number of items matching the query regardless of pagination."}},"description":"The last 50 member events for a list.","title":"lists_list-member-activity_Response_200"},"30ListsListIdMembersSubscriberHashActivityFeedGetParametersActivityFiltersSchemaItems":{"type":"string","enum":["bounce","click","conversation","ecommerce_signup","event","web_engagement","generic_signup","landing_page_signup","marketing_permission","note","open","order","postcard_sent","sent","signup","squatter_signup","unsub","website_signup","survey_response","sms_bulk_sent","inbox_thread","qbo_payment_link","video_call_transcripts","whatsapp_bulk_sent","whatsapp_delivered"],"title":"30ListsListIdMembersSubscriberHashActivityFeedGetParametersActivityFiltersSchemaItems"},"30ListsListIdMembersSubscriberHashActivityFeedGetResponsesContentApplicationJsonSchemaLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"30ListsListIdMembersSubscriberHashActivityFeedGetResponsesContentApplicationJsonSchemaLinksItemsMethod"},"30ListsListIdMembersSubscriberHashActivityFeedGetResponsesContentApplicationJsonSchemaLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/30ListsListIdMembersSubscriberHashActivityFeedGetResponsesContentApplicationJsonSchemaLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"30ListsListIdMembersSubscriberHashActivityFeedGetResponsesContentApplicationJsonSchemaLinksItems"},"lists_list-member-activity-feed_Response_200":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/30ListsListIdMembersSubscriberHashActivityFeedGetResponsesContentApplicationJsonSchemaLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"activity":{"type":"array","items":{"description":"Any type"},"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)."},"email_id":{"type":"string","description":"The MD5 hash of the lowercase version of the list member's email address."},"list_id":{"type":"string","description":"The list id."}},"description":"The member activity events for a given member.","title":"lists_list-member-activity-feed_Response_200"},"30ListsListIdMembersSubscriberHashEventsGetResponsesContentApplicationJsonSchemaLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"30ListsListIdMembersSubscriberHashEventsGetResponsesContentApplicationJsonSchemaLinksItemsMethod"},"30ListsListIdMembersSubscriberHashEventsGetResponsesContentApplicationJsonSchemaLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/30ListsListIdMembersSubscriberHashEventsGetResponsesContentApplicationJsonSchemaLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"30ListsListIdMembersSubscriberHashEventsGetResponsesContentApplicationJsonSchemaLinksItems"},"30ListsListIdMembersSubscriberHashEventsGetResponsesContentApplicationJsonSchemaEventsItems":{"type":"object","properties":{"name":{"type":"string","description":"The name for this type of event ('purchased', 'visited', etc). Must be 2-30 characters in length"},"occurred_at":{"type":"string","format":"date-time","description":"The date and time the event occurred in ISO 8601 format."},"properties":{"type":"object","additionalProperties":{"type":"string"},"description":"An optional list of properties"}},"description":"A specific event for a contact.","title":"30ListsListIdMembersSubscriberHashEventsGetResponsesContentApplicationJsonSchemaEventsItems"},"lists_list-member-events_Response_200":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/30ListsListIdMembersSubscriberHashEventsGetResponsesContentApplicationJsonSchemaLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"events":{"type":"array","items":{"$ref":"#/components/schemas/30ListsListIdMembersSubscriberHashEventsGetResponsesContentApplicationJsonSchemaEventsItems"},"description":"An array of objects, each representing an event."},"total_items":{"type":"integer","description":"The total number of items matching the query regardless of pagination."}},"description":"A collection of events for a given contact","title":"lists_list-member-events_Response_200"},"30ListsListIdMembersSubscriberHashGoalsGetResponsesContentApplicationJsonSchemaLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"30ListsListIdMembersSubscriberHashGoalsGetResponsesContentApplicationJsonSchemaLinksItemsMethod"},"30ListsListIdMembersSubscriberHashGoalsGetResponsesContentApplicationJsonSchemaLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/30ListsListIdMembersSubscriberHashGoalsGetResponsesContentApplicationJsonSchemaLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"30ListsListIdMembersSubscriberHashGoalsGetResponsesContentApplicationJsonSchemaLinksItems"},"30ListsListIdMembersSubscriberHashGoalsGetResponsesContentApplicationJsonSchemaGoalsItems":{"type":"object","properties":{"data":{"type":"string","description":"Any extra data passed with the Goal event."},"event":{"type":"string","description":"The name/type of Goal event triggered."},"goal_id":{"type":"integer","description":"The id for a Goal event."},"last_visited_at":{"type":"string","format":"date-time","description":"The date and time the user last triggered the Goal event in ISO 8601 format."}},"description":"A single instance of a goal activity.","title":"30ListsListIdMembersSubscriberHashGoalsGetResponsesContentApplicationJsonSchemaGoalsItems"},"lists_list-member-goals_Response_200":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/30ListsListIdMembersSubscriberHashGoalsGetResponsesContentApplicationJsonSchemaLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"email_id":{"type":"string","description":"The MD5 hash of the lowercase version of the list member's email address."},"goals":{"type":"array","items":{"$ref":"#/components/schemas/30ListsListIdMembersSubscriberHashGoalsGetResponsesContentApplicationJsonSchemaGoalsItems"},"description":"The last 50 Goal events triggered by a member."},"list_id":{"type":"string","description":"The list id."},"total_items":{"type":"integer","description":"The total number of items matching the query regardless of pagination."}},"description":"The last 50 Goal events for a member on a specific list.","title":"lists_list-member-goals_Response_200"},"30ListsListIdMembersSubscriberHashNotesGetParametersSortField":{"type":"string","enum":["created_at","updated_at","note_id"],"title":"30ListsListIdMembersSubscriberHashNotesGetParametersSortField"},"30ListsListIdMembersSubscriberHashNotesGetParametersSortDir":{"type":"string","enum":["ASC","DESC"],"title":"30ListsListIdMembersSubscriberHashNotesGetParametersSortDir"},"30ListsListIdMembersSubscriberHashNotesGetResponsesContentApplicationJsonSchemaLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"30ListsListIdMembersSubscriberHashNotesGetResponsesContentApplicationJsonSchemaLinksItemsMethod"},"30ListsListIdMembersSubscriberHashNotesGetResponsesContentApplicationJsonSchemaLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/30ListsListIdMembersSubscriberHashNotesGetResponsesContentApplicationJsonSchemaLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"30ListsListIdMembersSubscriberHashNotesGetResponsesContentApplicationJsonSchemaLinksItems"},"MemberNotesLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"MemberNotesLinksItemsMethod"},"MemberNotesLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/MemberNotesLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"MemberNotesLinksItems"},"MemberNotes":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/MemberNotesLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"contact_id":{"type":"string","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."},"created_at":{"type":"string","format":"date-time","description":"The date and time the note was created in ISO 8601 format."},"created_by":{"type":"string","description":"The author of the note."},"email_id":{"type":"string","description":"The MD5 hash of the lowercase version of the list member's email address."},"id":{"type":"integer","description":"The note id."},"list_id":{"type":"string","description":"The unique id for the list."},"note":{"type":"string","description":"The content of the note."},"updated_at":{"type":"string","format":"date-time","description":"The date and time the note was last updated in ISO 8601 format."}},"description":"A specific note for a specific member.","title":"MemberNotes"},"lists_list-member-notes_Response_200":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/30ListsListIdMembersSubscriberHashNotesGetResponsesContentApplicationJsonSchemaLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"email_id":{"type":"string","description":"The MD5 hash of the lowercase version of the list member's email address."},"list_id":{"type":"string","description":"The list id."},"notes":{"type":"array","items":{"$ref":"#/components/schemas/MemberNotes"},"description":"An array of objects, each representing a note resource."},"total_items":{"type":"integer","description":"The total number of items matching the query regardless of pagination."}},"description":"The last 10 notes for a specific list member, based on date created.","title":"lists_list-member-notes_Response_200"},"30ListsListIdMembersSubscriberHashTagsGetResponsesContentApplicationJsonSchemaLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"30ListsListIdMembersSubscriberHashTagsGetResponsesContentApplicationJsonSchemaLinksItemsMethod"},"30ListsListIdMembersSubscriberHashTagsGetResponsesContentApplicationJsonSchemaLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/30ListsListIdMembersSubscriberHashTagsGetResponsesContentApplicationJsonSchemaLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"30ListsListIdMembersSubscriberHashTagsGetResponsesContentApplicationJsonSchemaLinksItems"},"30ListsListIdMembersSubscriberHashTagsGetResponsesContentApplicationJsonSchemaTagsItems":{"type":"object","properties":{"date_added":{"type":"string","format":"date-time","description":"The date and time the tag was added to the list member in ISO 8601 format."},"id":{"type":"integer","description":"The unique id for the tag."},"name":{"type":"string","description":"The name of the tag."}},"title":"30ListsListIdMembersSubscriberHashTagsGetResponsesContentApplicationJsonSchemaTagsItems"},"lists_list-member-tags_Response_200":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/30ListsListIdMembersSubscriberHashTagsGetResponsesContentApplicationJsonSchemaLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"tags":{"type":"array","items":{"$ref":"#/components/schemas/30ListsListIdMembersSubscriberHashTagsGetResponsesContentApplicationJsonSchemaTagsItems"},"description":"A list of tags assigned to the list member."},"total_items":{"type":"integer","description":"The total number of items matching the query regardless of pagination."}},"description":"A list of tags assigned to a list member.","title":"lists_list-member-tags_Response_200"},"30ListsListIdMembersSubscriberHashTagsPostRequestBodyContentApplicationJsonSchemaTagsItemsStatus":{"type":"string","enum":["inactive","active"],"description":"The status for the tag on the member, pass in active to add a tag or inactive to remove it.","title":"30ListsListIdMembersSubscriberHashTagsPostRequestBodyContentApplicationJsonSchemaTagsItemsStatus"},"30ListsListIdMembersSubscriberHashTagsPostRequestBodyContentApplicationJsonSchemaTagsItems":{"type":"object","properties":{"name":{"type":"string","description":"The name of the tag."},"status":{"$ref":"#/components/schemas/30ListsListIdMembersSubscriberHashTagsPostRequestBodyContentApplicationJsonSchemaTagsItemsStatus","description":"The status for the tag on the member, pass in active to add a tag or inactive to remove it."}},"required":["name","status"],"description":"Add or remove tags on a member by declaring a tag either active or inactive on a member.","title":"30ListsListIdMembersSubscriberHashTagsPostRequestBodyContentApplicationJsonSchemaTagsItems"},"30ListsListIdMergeFieldsGetResponsesContentApplicationJsonSchemaLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"30ListsListIdMergeFieldsGetResponsesContentApplicationJsonSchemaLinksItemsMethod"},"30ListsListIdMergeFieldsGetResponsesContentApplicationJsonSchemaLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/30ListsListIdMergeFieldsGetResponsesContentApplicationJsonSchemaLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"30ListsListIdMergeFieldsGetResponsesContentApplicationJsonSchemaLinksItems"},"MergeFieldLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"MergeFieldLinksItemsMethod"},"MergeFieldLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/MergeFieldLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"MergeFieldLinksItems"},"MergeFieldOptions":{"type":"object","properties":{"choices":{"type":"array","items":{"type":"string"},"description":"In a radio or dropdown non-group field, the available options for contacts to pick from."},"date_format":{"type":"string","description":"In a date or birthday field, the format of the date."},"default_country":{"type":"integer","description":"In an address field, the default country code if none supplied."},"phone_format":{"type":"string","description":"In a phone field, the phone number type: US or International."},"size":{"type":"integer","description":"In a text field, the default length of the text field."}},"description":"Extra options for some merge field types.","title":"MergeFieldOptions"},"MergeFieldType":{"type":"string","enum":["text","number","address","phone","date","url","imageurl","radio","dropdown","birthday","zip"],"description":"The [type](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for the merge field.","title":"MergeFieldType"},"MergeField":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/MergeFieldLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"default_value":{"type":"string","description":"The default value for the merge field if `null`."},"display_order":{"type":"integer","description":"The order that the merge field displays on the list signup form."},"help_text":{"type":"string","description":"Extra text to help the subscriber fill out the form."},"list_id":{"type":"string","description":"The ID that identifies this merge field's audience'."},"merge_field_limit":{"type":"integer","description":"The maximum number of merge fields this audience can hold. The limit is determined by the account's plan. Returned on POST responses only. Subtract `total_items` from this value to derive the remaining capacity."},"merge_id":{"type":"integer","description":"An unchanging id for the merge field."},"name":{"type":"string","description":"The name of the merge field (audience field)."},"options":{"$ref":"#/components/schemas/MergeFieldOptions","description":"Extra options for some merge field types."},"public":{"type":"boolean","description":"Whether the merge field is displayed on the signup form."},"required":{"type":"boolean","description":"The boolean value if the merge field is required."},"tag":{"type":"string","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)."},"total_items":{"type":"integer","description":"The total number of merge fields on the audience after this field was created. Returned on POST responses only."},"type":{"$ref":"#/components/schemas/MergeFieldType","description":"The [type](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for the merge field."}},"description":"A [merge field](https://mailchimp.com/developer/marketing/docs/merge-fields/) for an audience.","title":"MergeField"},"lists_list-merge-fields_Response_200":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/30ListsListIdMergeFieldsGetResponsesContentApplicationJsonSchemaLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"list_id":{"type":"string","description":"The list id."},"merge_field_limit":{"type":"integer","description":"The maximum number of merge fields this audience can hold. The limit is determined by the account's plan. Subtract `total_items` from this value to derive the remaining capacity."},"merge_fields":{"type":"array","items":{"$ref":"#/components/schemas/MergeField"},"description":"An array of objects, each representing a merge field resource."},"total_items":{"type":"integer","description":"The total number of items matching the query regardless of pagination."}},"description":"The [merge fields](https://mailchimp.com/developer/marketing/docs/merge-fields/) for an audience.","title":"lists_list-merge-fields_Response_200"},"30ListsListIdMergeFieldsPostRequestBodyContentApplicationJsonSchemaOptions":{"type":"object","properties":{"choices":{"type":"array","items":{"type":"string"},"description":"In a radio or dropdown non-group field, the available options for contacts to pick from."},"date_format":{"type":"string","description":"In a date or birthday field, the format of the date."},"default_country":{"type":"integer","description":"In an address field, the default country code if none supplied."},"phone_format":{"type":"string","description":"In a phone field, the phone number type: US or International."},"size":{"type":"integer","description":"In a text field, the default length of the text field."}},"description":"Extra options for some merge field types.","title":"30ListsListIdMergeFieldsPostRequestBodyContentApplicationJsonSchemaOptions"},"30ListsListIdMergeFieldsPostRequestBodyContentApplicationJsonSchemaType":{"type":"string","enum":["text","number","address","phone","date","url","imageurl","radio","dropdown","birthday","zip"],"description":"The [type](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for the merge field.","title":"30ListsListIdMergeFieldsPostRequestBodyContentApplicationJsonSchemaType"},"30ListsListIdMergeFieldsMergeIdPatchRequestBodyContentApplicationJsonSchemaOptions":{"type":"object","properties":{"choices":{"type":"array","items":{"type":"string"},"description":"In a radio or dropdown non-group field, the available options for members to pick from."},"date_format":{"type":"string","description":"In a date or birthday field, the format of the date."},"default_country":{"type":"integer","description":"In an address field, the default country code if none supplied."},"phone_format":{"type":"string","description":"In a phone field, the phone number type: US or International."}},"description":"Extra options for some merge field types.","title":"30ListsListIdMergeFieldsMergeIdPatchRequestBodyContentApplicationJsonSchemaOptions"},"30ListsListIdSegmentsGetParametersExcludeType":{"type":"string","enum":["saved","static","fuzzy"],"title":"30ListsListIdSegmentsGetParametersExcludeType"},"30ListsListIdSegmentsGetResponsesContentApplicationJsonSchemaLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"30ListsListIdSegmentsGetResponsesContentApplicationJsonSchemaLinksItemsMethod"},"30ListsListIdSegmentsGetResponsesContentApplicationJsonSchemaLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/30ListsListIdSegmentsGetResponsesContentApplicationJsonSchemaLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"30ListsListIdSegmentsGetResponsesContentApplicationJsonSchemaLinksItems"},"ListLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"ListLinksItemsMethod"},"ListLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/ListLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"ListLinksItems"},"ListOptionsMatch":{"type":"string","enum":["any","all"],"description":"Match type.","title":"ListOptionsMatch"},"ListOptions":{"type":"object","properties":{"conditions":{"$ref":"#/components/schemas/SegmentType"},"match":{"$ref":"#/components/schemas/ListOptionsMatch","description":"Match type."}},"description":"The conditions of the segment. Static segments (tags) and fuzzy segments don't have conditions.","title":"ListOptions"},"ListType":{"type":"string","enum":["saved","static","fuzzy"],"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).","title":"ListType"},"List":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/ListLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"created_at":{"type":"string","format":"date-time","description":"The date and time the segment was created in ISO 8601 format."},"id":{"type":"integer","description":"The unique id for the segment."},"list_id":{"type":"string","description":"The list id."},"member_count":{"type":"integer","description":"The number of active subscribers currently included in the segment."},"name":{"type":"string","description":"The name of the segment."},"options":{"$ref":"#/components/schemas/ListOptions","description":"The conditions of the segment. Static segments (tags) and fuzzy segments don't have conditions."},"type":{"$ref":"#/components/schemas/ListType","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)."},"updated_at":{"type":"string","format":"date-time","description":"The date and time the segment was last updated in ISO 8601 format."}},"description":"Information about a specific segment.","title":"List"},"lists_list-segments_Response_200":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/30ListsListIdSegmentsGetResponsesContentApplicationJsonSchemaLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"list_id":{"type":"string","description":"The list id."},"segments":{"type":"array","items":{"$ref":"#/components/schemas/List"},"description":"An array of objects, each representing a list segment."},"total_items":{"type":"integer","description":"The total number of items matching the query regardless of pagination."}},"description":"A list of available segments.","title":"lists_list-segments_Response_200"},"30ListsListIdSegmentsPostRequestBodyContentApplicationJsonSchemaOptionsMatch":{"type":"string","enum":["any","all"],"description":"Match type.","title":"30ListsListIdSegmentsPostRequestBodyContentApplicationJsonSchemaOptionsMatch"},"30ListsListIdSegmentsPostRequestBodyContentApplicationJsonSchemaOptions":{"type":"object","properties":{"conditions":{"$ref":"#/components/schemas/SegmentType"},"match":{"$ref":"#/components/schemas/30ListsListIdSegmentsPostRequestBodyContentApplicationJsonSchemaOptionsMatch","description":"Match type."}},"description":"The [conditions of the segment](https://mailchimp.com/help/save-and-manage-segments/). Static and fuzzy segments don't have conditions.","title":"30ListsListIdSegmentsPostRequestBodyContentApplicationJsonSchemaOptions"},"30ListsListIdSegmentsSegmentIdPatchRequestBodyContentApplicationJsonSchemaOptionsMatch":{"type":"string","enum":["any","all"],"description":"Match type.","title":"30ListsListIdSegmentsSegmentIdPatchRequestBodyContentApplicationJsonSchemaOptionsMatch"},"30ListsListIdSegmentsSegmentIdPatchRequestBodyContentApplicationJsonSchemaOptions":{"type":"object","properties":{"conditions":{"$ref":"#/components/schemas/SegmentType"},"match":{"$ref":"#/components/schemas/30ListsListIdSegmentsSegmentIdPatchRequestBodyContentApplicationJsonSchemaOptionsMatch","description":"Match type."}},"description":"The [conditions of the segment](https://mailchimp.com/help/save-and-manage-segments/). Static and fuzzy segments don't have conditions.","title":"30ListsListIdSegmentsSegmentIdPatchRequestBodyContentApplicationJsonSchemaOptions"},"30ListsListIdSegmentsSegmentIdPostResponsesContentApplicationJsonSchemaLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"30ListsListIdSegmentsSegmentIdPostResponsesContentApplicationJsonSchemaLinksItemsMethod"},"30ListsListIdSegmentsSegmentIdPostResponsesContentApplicationJsonSchemaLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/30ListsListIdSegmentsSegmentIdPostResponsesContentApplicationJsonSchemaLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"30ListsListIdSegmentsSegmentIdPostResponsesContentApplicationJsonSchemaLinksItems"},"30ListsListIdSegmentsSegmentIdPostResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"email_addresses":{"type":"array","items":{"type":"string"},"description":"Email addresses added to the static segment or removed"},"error":{"type":"string","description":"The error message indicating why the email addresses could not be added or updated."}},"title":"30ListsListIdSegmentsSegmentIdPostResponsesContentApplicationJsonSchemaErrorsItems"},"lists_batch-add-or-remove-members_Response_200":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/30ListsListIdSegmentsSegmentIdPostResponsesContentApplicationJsonSchemaLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"error_count":{"type":"integer","description":"The total number of items matching the query, irrespective of pagination."},"errors":{"type":"array","items":{"$ref":"#/components/schemas/30ListsListIdSegmentsSegmentIdPostResponsesContentApplicationJsonSchemaErrorsItems"},"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."},"members_added":{"type":"array","items":{"$ref":"#/components/schemas/ListsPost"},"description":"An array of objects, each representing a new member that was added to the static segment."},"members_removed":{"type":"array","items":{"$ref":"#/components/schemas/ListsPost"},"description":"An array of objects, each representing an existing list member that got deleted from the static segment."},"total_added":{"type":"integer","description":"The total number of items matching the query, irrespective of pagination."},"total_removed":{"type":"integer","description":"The total number of items matching the query, irrespective of pagination."}},"description":"Batch add/remove List members to/from static segment","title":"lists_batch-add-or-remove-members_Response_200"},"30ListsListIdSegmentsSegmentIdMembersGetResponsesContentApplicationJsonSchemaLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"30ListsListIdSegmentsSegmentIdMembersGetResponsesContentApplicationJsonSchemaLinksItemsMethod"},"30ListsListIdSegmentsSegmentIdMembersGetResponsesContentApplicationJsonSchemaLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/30ListsListIdSegmentsSegmentIdMembersGetResponsesContentApplicationJsonSchemaLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"30ListsListIdSegmentsSegmentIdMembersGetResponsesContentApplicationJsonSchemaLinksItems"},"ListsSegmentsMembersLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"ListsSegmentsMembersLinksItemsMethod"},"ListsSegmentsMembersLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/ListsSegmentsMembersLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"ListsSegmentsMembersLinksItems"},"ListsSegmentsMembersLastNote":{"type":"object","properties":{"created_at":{"type":"string","format":"date-time","description":"The date and time the note was created in ISO 8601 format."},"created_by":{"type":"string","description":"The author of the note."},"note":{"type":"string","description":"The content of the note."},"note_id":{"type":"integer","description":"The note id."}},"description":"The most recent Note added about this member.","title":"ListsSegmentsMembersLastNote"},"ListsSegmentsMembersLocation":{"type":"object","properties":{"country_code":{"type":"string","description":"The unique code for the location country."},"dstoff":{"type":"integer","description":"The offset for timezones where daylight saving time is observed."},"gmtoff":{"type":"integer","description":"The time difference in hours from GMT."},"latitude":{"type":"number","format":"double","description":"The location latitude."},"longitude":{"type":"number","format":"double","description":"The location longitude."},"timezone":{"type":"string","description":"The timezone for the location."}},"description":"Subscriber location information.","title":"ListsSegmentsMembersLocation"},"ListsSegmentsMembersMergeFields0":{"type":"object","properties":{"addr1":{"type":"string"},"addr2":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"zip":{"type":"string"},"country":{"type":"string"}},"required":["addr1","city","state","zip"],"title":"ListsSegmentsMembersMergeFields0"},"ListsSegmentsMembersMergeFields":{"oneOf":[{"$ref":"#/components/schemas/ListsSegmentsMembersMergeFields0"},{"type":"string"},{"type":"number","format":"double"}],"description":"This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field.","title":"ListsSegmentsMembersMergeFields"},"ListsSegmentsMembersStats":{"type":"object","properties":{"avg_click_rate":{"type":"number","format":"double","description":"A subscriber's average clickthrough rate."},"avg_open_rate":{"type":"number","format":"double","description":"A subscriber's average open rate."}},"description":"Open and click rates for this subscriber.","title":"ListsSegmentsMembersStats"},"ListsSegmentsMembersStatus":{"type":"string","enum":["subscribed","unsubscribed","cleaned","pending","transactional"],"description":"Subscriber's current status.","title":"ListsSegmentsMembersStatus"},"ListsSegmentsMembers":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/ListsSegmentsMembersLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"email_address":{"type":"string","description":"Email address for a subscriber."},"email_client":{"type":"string","description":"The list member's email client."},"email_type":{"type":"string","description":"Type of email this member asked to get ('html' or 'text')."},"full_name":{"type":"string","description":"The contact's full name."},"id":{"type":"string","description":"The MD5 hash of the lowercase version of the list member's email address."},"interests":{"type":"object","additionalProperties":{"type":"boolean"},"description":"The key of this object's properties is the ID of the interest in question."},"ip_opt":{"type":"string","description":"The IP address the subscriber used to confirm their opt-in status."},"ip_signup":{"type":"string","description":"IP address the subscriber signed up from."},"language":{"type":"string","description":"If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/)."},"last_changed":{"type":"string","format":"date-time","description":"The date and time the member's info was last changed in ISO 8601 format."},"last_note":{"$ref":"#/components/schemas/ListsSegmentsMembersLastNote","description":"The most recent Note added about this member."},"list_id":{"type":"string","description":"The list id."},"location":{"$ref":"#/components/schemas/ListsSegmentsMembersLocation","description":"Subscriber location information."},"member_rating":{"type":"integer","description":"Star rating for this member, between 1 and 5."},"merge_fields":{"type":["object","null"],"additionalProperties":{"$ref":"#/components/schemas/ListsSegmentsMembersMergeFields"},"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."},"stats":{"$ref":"#/components/schemas/ListsSegmentsMembersStats","description":"Open and click rates for this subscriber."},"status":{"$ref":"#/components/schemas/ListsSegmentsMembersStatus","description":"Subscriber's current status."},"timestamp_opt":{"type":"string","format":"date-time","description":"The date and time the subscriber confirmed their opt-in status in ISO 8601 format."},"timestamp_signup":{"type":"string","format":"date-time","description":"The date and time the subscriber signed up for the list in ISO 8601 format."},"unique_email_id":{"type":"string","description":"An identifier for the address across all of Mailchimp."},"vip":{"type":"boolean","description":"[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber."}},"description":"Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed.","title":"ListsSegmentsMembers"},"lists_list-segment-members_Response_200":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/30ListsListIdSegmentsSegmentIdMembersGetResponsesContentApplicationJsonSchemaLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"members":{"type":"array","items":{"$ref":"#/components/schemas/ListsSegmentsMembers"},"description":"An array of objects, each representing a specific list member."},"total_items":{"type":"integer","description":"The total number of items matching the query regardless of pagination."}},"description":"View members in a specific list segment.","title":"lists_list-segment-members_Response_200"},"lists_list-surveys_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"lists_list-surveys_Response_200"},"SurveySectionRequestType":{"type":"string","enum":["introduction","context","question"],"description":"The section type.","title":"SurveySectionRequestType"},"SurveySectionRequestOptions":{"type":"object","properties":{},"description":"Additional section options.","title":"SurveySectionRequestOptions"},"SurveySectionRequestQuestionType":{"type":"string","enum":["pickOne","pickMany","range","text","email","contactInformation","dropdown"],"description":"The response type of the survey question.","title":"SurveySectionRequestQuestionType"},"SurveySectionRequestQuestionOptionsItems":{"type":"object","properties":{"label":{"type":"string"},"value":{"type":"string"}},"required":["label","value"],"title":"SurveySectionRequestQuestionOptionsItems"},"SurveySectionRequestQuestionMergeField":{"type":"object","properties":{},"description":"Merge field mapping for contact information questions.","title":"SurveySectionRequestQuestionMergeField"},"SurveySectionRequestQuestion":{"type":"object","properties":{"id":{"type":"string","description":"The question ID. On PATCH, include to update an existing question; omit to add a new question."},"query":{"type":"string","description":"The question text."},"type":{"$ref":"#/components/schemas/SurveySectionRequestQuestionType","description":"The response type of the survey question."},"is_required":{"type":"boolean","description":"Whether this question is required."},"has_other":{"type":"boolean","description":"Whether this question has an 'other' option."},"other_label":{"type":"string","description":"Label for the 'other' option."},"range_low_label":{"type":"string","description":"Label for the low end of a range question."},"range_high_label":{"type":"string","description":"Label for the high end of a range question."},"range_low_value":{"type":"integer","description":"Low value for a range question."},"range_high_value":{"type":"integer","description":"High value for a range question."},"range_presentation":{"type":"string","description":"How a range question is presented."},"placeholder_label":{"type":"string","description":"Placeholder text for text or email questions."},"subscribe_checkbox_enabled":{"type":"boolean","description":"Whether the subscribe checkbox is enabled."},"subscribe_checkbox_label":{"type":"string","description":"Label for the subscribe checkbox."},"should_auto_tag":{"type":"boolean","description":"Whether responses should automatically apply tags."},"options":{"type":"array","items":{"$ref":"#/components/schemas/SurveySectionRequestQuestionOptionsItems"},"description":"Answer options for pickOne, pickMany, or dropdown questions."},"merge_field":{"$ref":"#/components/schemas/SurveySectionRequestQuestionMergeField","description":"Merge field mapping for contact information questions."}},"required":["query","type"],"description":"A survey question. On PATCH, include the question id to update it. Omitting question id creates a new question; it does not delete an existing one. To delete a question, omit its section from the sections array.","title":"SurveySectionRequestQuestion"},"SurveySectionRequest":{"type":"object","properties":{"id":{"type":"string","description":"The section ID. On PATCH, include to update an existing section; omit to add a new section."},"type":{"$ref":"#/components/schemas/SurveySectionRequestType","description":"The section type."},"text":{"type":"string","description":"Rich text content for introduction or context sections."},"options":{"$ref":"#/components/schemas/SurveySectionRequestOptions","description":"Additional section options."},"question":{"$ref":"#/components/schemas/SurveySectionRequestQuestion","description":"A survey question. On PATCH, include the question id to update it. Omitting question id creates a new question; it does not delete an existing one. To delete a question, omit its section from the sections array."}},"required":["type"],"description":"A survey section. On PATCH, include the section id to update it; omit the section from the sections array to delete it (and any question it contains).","title":"SurveySectionRequest"},"lists_create-survey_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"lists_create-survey_Response_200"},"lists_get-survey_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"lists_get-survey_Response_200"},"lists_update-survey_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"lists_update-survey_Response_200"},"surveys_create-list-survey-action-publish_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"surveys_create-list-survey-action-publish_Response_200"},"lists_create-list-survey-action-replicate_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"lists_create-list-survey-action-replicate_Response_200"},"surveys_create-list-survey-action-unpublish_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"surveys_create-list-survey-action-unpublish_Response_200"},"30ListsListIdWebhooksGetResponsesContentApplicationJsonSchemaLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"30ListsListIdWebhooksGetResponsesContentApplicationJsonSchemaLinksItemsMethod"},"30ListsListIdWebhooksGetResponsesContentApplicationJsonSchemaLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/30ListsListIdWebhooksGetResponsesContentApplicationJsonSchemaLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"30ListsListIdWebhooksGetResponsesContentApplicationJsonSchemaLinksItems"},"ListWebhooksLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"ListWebhooksLinksItemsMethod"},"ListWebhooksLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/ListWebhooksLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"ListWebhooksLinksItems"},"ListWebhooksEvents":{"type":"object","properties":{"campaign":{"type":"boolean","description":"Whether the webhook is triggered when a campaign is sent or cancelled."},"cleaned":{"type":"boolean","description":"Whether the webhook is triggered when a subscriber's email address is cleaned from the list."},"profile":{"type":"boolean","description":"Whether the webhook is triggered when a contact's profile is updated. This includes email subscribers and SMS-only contacts [BETA]."},"subscribe":{"type":"boolean","description":"Whether the webhook is triggered when a list subscriber is added."},"unsubscribe":{"type":"boolean","description":"Whether the webhook is triggered when a list member unsubscribes."},"upemail":{"type":"boolean","description":"Whether the webhook is triggered when a subscriber's email address is changed."},"sms_subscribe":{"type":"boolean","description":"[BETA] Whether the webhook is triggered when a contact subscribes to SMS."},"sms_unsubscribe":{"type":"boolean","description":"[BETA] Whether the webhook is triggered when a contact unsubscribes from SMS."},"upsms":{"type":"boolean","description":"[BETA] Whether the webhook is triggered when a contact's SMS phone number is updated."},"sms_campaign":{"type":"boolean","description":"[BETA] Whether the webhook is triggered when an SMS campaign is sent."}},"description":"The events that can trigger the webhook and whether they are enabled.","title":"ListWebhooksEvents"},"ListWebhooksSources":{"type":"object","properties":{"admin":{"type":"boolean","description":"Whether the webhook is triggered by admin-initiated actions in the web interface."},"api":{"type":"boolean","description":"Whether the webhook is triggered by actions initiated via the API."},"user":{"type":"boolean","description":"Whether the webhook is triggered by subscriber-initiated actions."}},"description":"The possible sources of any events that can trigger the webhook and whether they are enabled.","title":"ListWebhooksSources"},"ListWebhooks":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/ListWebhooksLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"events":{"$ref":"#/components/schemas/ListWebhooksEvents","description":"The events that can trigger the webhook and whether they are enabled."},"id":{"type":"string","description":"An string that uniquely identifies this webhook."},"list_id":{"type":"string","description":"The unique id for the list."},"signing_enabled":{"type":"boolean","description":"Whether outbound deliveries are HMAC-signed."},"sources":{"$ref":"#/components/schemas/ListWebhooksSources","description":"The possible sources of any events that can trigger the webhook and whether they are enabled."},"url":{"type":"string","description":"A valid URL for the Webhook."}},"description":"Webhook configured for the given list.","title":"ListWebhooks"},"lists_list-webhooks_Response_200":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/30ListsListIdWebhooksGetResponsesContentApplicationJsonSchemaLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"list_id":{"type":"string","description":"The list id."},"total_items":{"type":"integer","description":"The total number of items matching the query regardless of pagination."},"webhooks":{"type":"array","items":{"$ref":"#/components/schemas/ListWebhooks"},"description":"An array of objects, each representing a specific list member."}},"description":"Manage webhooks for a specific list.","title":"lists_list-webhooks_Response_200"},"AddWebhookEvents":{"type":"object","properties":{"campaign":{"type":"boolean","description":"Whether the webhook is triggered when a campaign is sent or cancelled."},"cleaned":{"type":"boolean","description":"Whether the webhook is triggered when a subscriber's email address is cleaned from the list."},"profile":{"type":"boolean","description":"Whether the webhook is triggered when a contact's profile is updated. This includes email subscribers and SMS-only contacts [BETA]."},"subscribe":{"type":"boolean","description":"Whether the webhook is triggered when a list subscriber is added."},"unsubscribe":{"type":"boolean","description":"Whether the webhook is triggered when a list member unsubscribes."},"upemail":{"type":"boolean","description":"Whether the webhook is triggered when a subscriber's email address is changed."},"sms_subscribe":{"type":"boolean","description":"[BETA] Whether the webhook is triggered when a contact subscribes to SMS."},"sms_unsubscribe":{"type":"boolean","description":"[BETA] Whether the webhook is triggered when a contact unsubscribes from SMS."},"upsms":{"type":"boolean","description":"[BETA] Whether the webhook is triggered when a contact's SMS phone number is updated."},"sms_campaign":{"type":"boolean","description":"[BETA] Whether the webhook is triggered when an SMS campaign is sent."}},"description":"The events that can trigger the webhook and whether they are enabled.","title":"AddWebhookEvents"},"AddWebhookSources":{"type":"object","properties":{"admin":{"type":"boolean","description":"Whether the webhook is triggered by admin-initiated actions in the web interface."},"api":{"type":"boolean","description":"Whether the webhook is triggered by actions initiated via the API."},"user":{"type":"boolean","description":"Whether the webhook is triggered by subscriber-initiated actions."}},"description":"The possible sources of any events that can trigger the webhook and whether they are enabled.","title":"AddWebhookSources"},"AddWebhook":{"type":"object","properties":{"events":{"$ref":"#/components/schemas/AddWebhookEvents","description":"The events that can trigger the webhook and whether they are enabled."},"sources":{"$ref":"#/components/schemas/AddWebhookSources","description":"The possible sources of any events that can trigger the webhook and whether they are enabled."},"url":{"type":"string","description":"A valid URL for the Webhook."}},"description":"Configure a webhook for the given list.","title":"AddWebhook"},"30ListsListIdWebhooksPostResponsesContentApplicationJsonSchemaLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"30ListsListIdWebhooksPostResponsesContentApplicationJsonSchemaLinksItemsMethod"},"30ListsListIdWebhooksPostResponsesContentApplicationJsonSchemaLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/30ListsListIdWebhooksPostResponsesContentApplicationJsonSchemaLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"30ListsListIdWebhooksPostResponsesContentApplicationJsonSchemaLinksItems"},"30ListsListIdWebhooksPostResponsesContentApplicationJsonSchemaEvents":{"type":"object","properties":{"campaign":{"type":"boolean","description":"Whether the webhook is triggered when a campaign is sent or cancelled."},"cleaned":{"type":"boolean","description":"Whether the webhook is triggered when a subscriber's email address is cleaned from the list."},"profile":{"type":"boolean","description":"Whether the webhook is triggered when a contact's profile is updated. This includes email subscribers and SMS-only contacts [BETA]."},"subscribe":{"type":"boolean","description":"Whether the webhook is triggered when a list subscriber is added."},"unsubscribe":{"type":"boolean","description":"Whether the webhook is triggered when a list member unsubscribes."},"upemail":{"type":"boolean","description":"Whether the webhook is triggered when a subscriber's email address is changed."},"sms_subscribe":{"type":"boolean","description":"[BETA] Whether the webhook is triggered when a contact subscribes to SMS."},"sms_unsubscribe":{"type":"boolean","description":"[BETA] Whether the webhook is triggered when a contact unsubscribes from SMS."},"upsms":{"type":"boolean","description":"[BETA] Whether the webhook is triggered when a contact's SMS phone number is updated."},"sms_campaign":{"type":"boolean","description":"[BETA] Whether the webhook is triggered when an SMS campaign is sent."}},"description":"The events that can trigger the webhook and whether they are enabled.","title":"30ListsListIdWebhooksPostResponsesContentApplicationJsonSchemaEvents"},"30ListsListIdWebhooksPostResponsesContentApplicationJsonSchemaSources":{"type":"object","properties":{"admin":{"type":"boolean","description":"Whether the webhook is triggered by admin-initiated actions in the web interface."},"api":{"type":"boolean","description":"Whether the webhook is triggered by actions initiated via the API."},"user":{"type":"boolean","description":"Whether the webhook is triggered by subscriber-initiated actions."}},"description":"The possible sources of any events that can trigger the webhook and whether they are enabled.","title":"30ListsListIdWebhooksPostResponsesContentApplicationJsonSchemaSources"},"lists_create-webhook_Response_200":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/30ListsListIdWebhooksPostResponsesContentApplicationJsonSchemaLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"events":{"$ref":"#/components/schemas/30ListsListIdWebhooksPostResponsesContentApplicationJsonSchemaEvents","description":"The events that can trigger the webhook and whether they are enabled."},"id":{"type":"string","description":"An string that uniquely identifies this webhook."},"list_id":{"type":"string","description":"The unique id for the list."},"signing_enabled":{"type":"boolean","description":"Whether outbound deliveries are HMAC-signed."},"sources":{"$ref":"#/components/schemas/30ListsListIdWebhooksPostResponsesContentApplicationJsonSchemaSources","description":"The possible sources of any events that can trigger the webhook and whether they are enabled."},"url":{"type":"string","description":"A valid URL for the Webhook."},"signing_secret":{"type":"string","description":"The HMAC signing secret. Returned exactly once at creation. This should be stored securely; if lost, delete and recreate the webhook to obtain a new secret."}},"description":"Webhook configured for the given list.","title":"lists_create-webhook_Response_200"},"ping_list_Response_200":{"type":"object","properties":{"health_status":{"type":"string","description":"This will return a constant string value if the request is successful. Ex. \"Everything's Chimpy!\""}},"description":"API health status.","title":"ping_list_Response_200"},"30ReportingGetResponsesContentApplicationJsonSchemaItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"30ReportingGetResponsesContentApplicationJsonSchemaItemsMethod"},"30ReportingGetResponsesContentApplicationJsonSchemaItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/30ReportingGetResponsesContentApplicationJsonSchemaItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"30ReportingGetResponsesContentApplicationJsonSchemaItems"},"30ReportingFacebookAdsGetParametersSortField":{"type":"string","enum":["created_at","updated_at","end_time"],"title":"30ReportingFacebookAdsGetParametersSortField"},"30ReportingFacebookAdsGetParametersSortDir":{"type":"string","enum":["ASC","DESC"],"title":"30ReportingFacebookAdsGetParametersSortDir"},"30ReportingFacebookAdsGetResponsesContentApplicationJsonSchemaLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"30ReportingFacebookAdsGetResponsesContentApplicationJsonSchemaLinksItemsMethod"},"30ReportingFacebookAdsGetResponsesContentApplicationJsonSchemaLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/30ReportingFacebookAdsGetResponsesContentApplicationJsonSchemaLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"30ReportingFacebookAdsGetResponsesContentApplicationJsonSchemaLinksItems"},"ReportingFacebookAdRecipientsSegmentOptsMatch":{"type":"string","enum":["any","all"],"description":"Segment match type.","title":"ReportingFacebookAdRecipientsSegmentOptsMatch"},"ReportingFacebookAdRecipientsSegmentOptsSavedSegmentId":{"oneOf":[{"type":"integer"},{"type":"string","pattern":"^[0-9]+$"}],"description":"The id for an existing saved segment.","title":"ReportingFacebookAdRecipientsSegmentOptsSavedSegmentId"},"ReportingFacebookAdRecipientsSegmentOpts":{"type":"object","properties":{"conditions":{"$ref":"#/components/schemas/SegmentType"},"match":{"$ref":"#/components/schemas/ReportingFacebookAdRecipientsSegmentOptsMatch","description":"Segment match type."},"prebuilt_segment_id":{"type":"string","description":"The prebuilt segment id, if a prebuilt segment has been designated for this campaign."},"saved_segment_id":{"$ref":"#/components/schemas/ReportingFacebookAdRecipientsSegmentOptsSavedSegmentId","description":"The id for an existing saved segment."}},"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.","title":"ReportingFacebookAdRecipientsSegmentOpts"},"ReportingFacebookAdRecipients":{"type":"object","properties":{"list_id":{"type":"string","description":"The unique list id."},"list_is_active":{"type":"boolean","description":"The status of the list used, namely if it's deleted or disabled."},"list_name":{"type":"string","description":"The name of the list."},"recipient_count":{"type":"integer","description":"Count of the recipients on the associated list. Formatted as an integer."},"segment_opts":{"$ref":"#/components/schemas/ReportingFacebookAdRecipientsSegmentOpts","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."},"segment_text":{"type":"string","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."}},"description":"High level audience information for who the outreach targets.","title":"ReportingFacebookAdRecipients"},"ReportingFacebookAdReportSummaryEcommerce":{"type":"object","properties":{"average_order_revenue":{"type":"number","format":"double"},"currency_code":{"type":"string"},"total_revenue":{"type":"number","format":"double"}},"title":"ReportingFacebookAdReportSummaryEcommerce"},"ReportingFacebookAdReportSummaryAverageDailyBudget":{"type":"object","properties":{"amount":{"type":"number","format":"double"},"currency_code":{"type":"string"}},"title":"ReportingFacebookAdReportSummaryAverageDailyBudget"},"ReportingFacebookAdReportSummaryAverageOrderAmount":{"type":"object","properties":{"amount":{"type":"number","format":"double"},"currency_code":{"type":"string"}},"title":"ReportingFacebookAdReportSummaryAverageOrderAmount"},"ReportingFacebookAdReportSummaryCostPerClick":{"type":"object","properties":{"amount":{"type":"number","format":"double"},"currency_code":{"type":"string"}},"title":"ReportingFacebookAdReportSummaryCostPerClick"},"ReportingFacebookAdReportSummaryExtendedAt":{"type":"object","properties":{"datetime":{"type":"string"},"timezone":{"type":"string"}},"title":"ReportingFacebookAdReportSummaryExtendedAt"},"ReportingFacebookAdReportSummary":{"type":"object","properties":{"click_rate":{"type":"number","format":"double"},"clicks":{"type":"integer"},"conversion_rate":{"type":"number","format":"double"},"ecommerce":{"$ref":"#/components/schemas/ReportingFacebookAdReportSummaryEcommerce"},"engagements":{"type":"integer"},"impressions":{"type":"integer"},"open_rate":{"type":"number","format":"double"},"opens":{"type":"integer"},"proxy_excluded_open_rate":{"type":"number","format":"double"},"proxy_excluded_opens":{"type":"integer"},"proxy_excluded_unique_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"},"average_daily_budget":{"$ref":"#/components/schemas/ReportingFacebookAdReportSummaryAverageDailyBudget"},"average_order_amount":{"$ref":"#/components/schemas/ReportingFacebookAdReportSummaryAverageOrderAmount"},"comments":{"type":"integer"},"cost_per_click":{"$ref":"#/components/schemas/ReportingFacebookAdReportSummaryCostPerClick"},"extended_at":{"$ref":"#/components/schemas/ReportingFacebookAdReportSummaryExtendedAt"},"first_time_buyers":{"type":"integer"},"has_extended_ad_duration":{"type":"boolean"},"likes":{"type":"integer"},"return_on_investment":{"type":"number","format":"double"},"shares":{"type":"integer"},"total_orders":{"type":"integer"},"total_products_sold":{"type":"integer"},"unique_clicks":{"type":"integer"}},"description":"Report summary of facebook ad","title":"ReportingFacebookAdReportSummary"},"ReportingFacebookAdStatus":{"type":"string","enum":["save","paused","schedule","scheduled","sending","sent","canceled","canceling","active","disconnected","somepaused","draft","completed","partialRejected","pending","rejected","published","unpublished"],"description":"The status of this outreach.","title":"ReportingFacebookAdStatus"},"ReportingFacebookAdType":{"type":"string","enum":["regular","email-touchpoint","plaintext","rss","reconfirm","variate","absplit","automation","facebook","google","autoresponder","transactional","page","website","social_post","survey","customer_journey","sms"],"description":"The type of outreach this object is.","title":"ReportingFacebookAdType"},"ReportingFacebookAdAudienceEmailSource":{"type":"object","properties":{"is_segment":{"type":"boolean","description":"Is the source reference a segment"},"list_name":{"type":"string","description":"Associated list name to the source"},"name":{"type":"string","description":"Email source name"},"segment_type":{"type":"string","description":"Segment type if this source is tied to a segment"},"type":{"type":"string","description":"Type of the email source"}},"title":"ReportingFacebookAdAudienceEmailSource"},"ReportingFacebookAdAudienceSourceType":{"type":"string","enum":["facebook","list"],"description":"List or Facebook based audience","title":"ReportingFacebookAdAudienceSourceType"},"ReportingFacebookAdAudienceTargetingSpecsGender":{"type":"string","enum":["0","1","2"],"title":"ReportingFacebookAdAudienceTargetingSpecsGender"},"ReportingFacebookAdAudienceTargetingSpecsInterestsItems":{"type":"object","properties":{"name":{"type":"string"}},"title":"ReportingFacebookAdAudienceTargetingSpecsInterestsItems"},"ReportingFacebookAdAudienceTargetingSpecsLocations":{"type":"object","properties":{"cities":{"type":"array","items":{"type":"string"}},"countries":{"type":"array","items":{"type":"string"}},"regions":{"type":"array","items":{"type":"string"}},"zips":{"type":"array","items":{"type":"string"}}},"title":"ReportingFacebookAdAudienceTargetingSpecsLocations"},"ReportingFacebookAdAudienceTargetingSpecs":{"type":"object","properties":{"gender":{"$ref":"#/components/schemas/ReportingFacebookAdAudienceTargetingSpecsGender"},"interests":{"type":"array","items":{"$ref":"#/components/schemas/ReportingFacebookAdAudienceTargetingSpecsInterestsItems"}},"locations":{"$ref":"#/components/schemas/ReportingFacebookAdAudienceTargetingSpecsLocations"},"max_age":{"type":"integer"},"min_age":{"type":"integer"}},"title":"ReportingFacebookAdAudienceTargetingSpecs"},"ReportingFacebookAdAudienceType":{"type":"string","enum":["Custom Audience","Lookalike Audience","Interest-based Audience"],"description":"Type of the audience","title":"ReportingFacebookAdAudienceType"},"ReportingFacebookAdAudience":{"type":"object","properties":{"email_source":{"$ref":"#/components/schemas/ReportingFacebookAdAudienceEmailSource"},"include_source_in_target":{"type":"boolean","description":"To include list contacts as part of audience"},"lookalike_country_code":{"type":"string","description":"To find similar audience in given country"},"source_type":{"$ref":"#/components/schemas/ReportingFacebookAdAudienceSourceType","description":"List or Facebook based audience"},"targeting_specs":{"$ref":"#/components/schemas/ReportingFacebookAdAudienceTargetingSpecs"},"type":{"$ref":"#/components/schemas/ReportingFacebookAdAudienceType","description":"Type of the audience"}},"description":"Audience settings","title":"ReportingFacebookAdAudience"},"ReportingFacebookAdAudienceActivityClicksItems":{"type":"object","properties":{"clicks":{"type":"integer"},"date":{"type":"string"}},"title":"ReportingFacebookAdAudienceActivityClicksItems"},"ReportingFacebookAdAudienceActivityImpressionsItems":{"type":"object","properties":{"date":{"type":"string"},"impressions":{"type":"integer"}},"title":"ReportingFacebookAdAudienceActivityImpressionsItems"},"ReportingFacebookAdAudienceActivityRevenueItems":{"type":"object","properties":{"date":{"type":"string"},"revenue":{"type":"number","format":"double"}},"title":"ReportingFacebookAdAudienceActivityRevenueItems"},"ReportingFacebookAdAudienceActivity":{"type":"object","properties":{"clicks":{"type":"array","items":{"$ref":"#/components/schemas/ReportingFacebookAdAudienceActivityClicksItems"}},"impressions":{"type":"array","items":{"$ref":"#/components/schemas/ReportingFacebookAdAudienceActivityImpressionsItems"}},"revenue":{"type":"array","items":{"$ref":"#/components/schemas/ReportingFacebookAdAudienceActivityRevenueItems"}}},"title":"ReportingFacebookAdAudienceActivity"},"ReportingFacebookAdBudget":{"type":"object","properties":{"currency_code":{"type":"string","description":"Currency code"},"duration":{"type":"integer","description":"Duration of the ad in seconds"},"total_amount":{"type":"number","format":"double","description":"Total budget of the ad"}},"title":"ReportingFacebookAdBudget"},"ReportingFacebookAdChannel":{"type":"object","properties":{"fb_placement_audience":{"type":"boolean","description":"Is this for facebook audience"},"fb_placement_feed":{"type":"boolean","description":"Is this for facebook feed"},"ig_placement_feed":{"type":"boolean","description":"Is this for instagram feed"}},"description":"Channel settings","title":"ReportingFacebookAdChannel"},"ReportingFacebookAdLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"ReportingFacebookAdLinksItemsMethod"},"ReportingFacebookAdLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/ReportingFacebookAdLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"ReportingFacebookAdLinksItems"},"ReportingFacebookAd":{"type":"object","properties":{"canceled_at":{"type":"string","format":"date-time","description":"The date and time the outreach was canceled in ISO 8601 format."},"create_time":{"type":"string","format":"date-time","description":"The date and time the outreach was created in ISO 8601 format."},"has_segment":{"type":"boolean","description":"If this outreach targets a segment of your audience."},"id":{"type":"string","description":"Unique ID of an Outreach."},"name":{"type":"string","description":"Title or name of an Outreach."},"published_time":{"type":"string","format":"date-time","description":"The date and time the outreach was (or will be) published in ISO 8601 format."},"recipients":{"$ref":"#/components/schemas/ReportingFacebookAdRecipients","description":"High level audience information for who the outreach targets."},"report_summary":{"$ref":"#/components/schemas/ReportingFacebookAdReportSummary","description":"Report summary of facebook ad"},"show_report":{"type":"boolean","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."},"start_time":{"type":"string","format":"date-time","description":"The date and time the outreach was started in ISO 8601 format."},"status":{"$ref":"#/components/schemas/ReportingFacebookAdStatus","description":"The status of this outreach."},"type":{"$ref":"#/components/schemas/ReportingFacebookAdType","description":"The type of outreach this object is."},"updated_at":{"type":"string","format":"date-time","description":"The date and time the outreach was last updated in ISO 8601 format."},"web_id":{"type":"integer","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}`."},"email_source_name":{"type":"string"},"end_time":{"type":"string","format":"date-time","description":"The date and time the ad was ended in ISO 8601 format."},"needs_attention":{"type":"boolean","description":"If the ad has a problem and needs attention."},"paused_at":{"type":"string","format":"date-time","description":"The date and time the ad was paused in ISO 8601 format."},"thumbnail":{"type":"string","description":"The URL of the thumbnail for this outreach."},"was_canceled_by_facebook":{"type":"boolean"},"audience":{"$ref":"#/components/schemas/ReportingFacebookAdAudience","description":"Audience settings"},"audience_activity":{"$ref":"#/components/schemas/ReportingFacebookAdAudienceActivity"},"budget":{"$ref":"#/components/schemas/ReportingFacebookAdBudget"},"channel":{"$ref":"#/components/schemas/ReportingFacebookAdChannel","description":"Channel settings"},"_links":{"type":"array","items":{"$ref":"#/components/schemas/ReportingFacebookAdLinksItems"},"description":"A list of link types and descriptions for the API schema documents."}},"title":"ReportingFacebookAd"},"reporting_list-facebook-ads_Response_200":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/30ReportingFacebookAdsGetResponsesContentApplicationJsonSchemaLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"facebook_ads":{"type":"array","items":{"$ref":"#/components/schemas/ReportingFacebookAd"}},"total_items":{"type":"integer","description":"The total number of items matching the query regardless of pagination."}},"description":"A collection of Facebook ads.","title":"reporting_list-facebook-ads_Response_200"},"30ReportingFacebookAdsOutreachIdEcommerceProductActivityGetParametersSortField":{"type":"string","enum":["title","total_revenue","total_purchased"],"title":"30ReportingFacebookAdsOutreachIdEcommerceProductActivityGetParametersSortField"},"30ReportingFacebookAdsOutreachIdEcommerceProductActivityGetResponsesContentApplicationJsonSchemaLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"30ReportingFacebookAdsOutreachIdEcommerceProductActivityGetResponsesContentApplicationJsonSchemaLinksItemsMethod"},"30ReportingFacebookAdsOutreachIdEcommerceProductActivityGetResponsesContentApplicationJsonSchemaLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/30ReportingFacebookAdsOutreachIdEcommerceProductActivityGetResponsesContentApplicationJsonSchemaLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"30ReportingFacebookAdsOutreachIdEcommerceProductActivityGetResponsesContentApplicationJsonSchemaLinksItems"},"30ReportingFacebookAdsOutreachIdEcommerceProductActivityGetResponsesContentApplicationJsonSchemaProductsItems":{"type":"object","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","format":"double"},"total_revenue":{"type":"number","format":"double"}},"title":"30ReportingFacebookAdsOutreachIdEcommerceProductActivityGetResponsesContentApplicationJsonSchemaProductsItems"},"reporting_list-facebook-ad-ecommerce-product-activity_Response_200":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/30ReportingFacebookAdsOutreachIdEcommerceProductActivityGetResponsesContentApplicationJsonSchemaLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"products":{"type":"array","items":{"$ref":"#/components/schemas/30ReportingFacebookAdsOutreachIdEcommerceProductActivityGetResponsesContentApplicationJsonSchemaProductsItems"}},"total_items":{"type":"integer","description":"The total number of items matching the query regardless of pagination."}},"description":"A collection of ecommerce products.","title":"reporting_list-facebook-ad-ecommerce-product-activity_Response_200"},"30ReportingLandingPagesGetResponsesContentApplicationJsonSchemaLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"30ReportingLandingPagesGetResponsesContentApplicationJsonSchemaLinksItemsMethod"},"30ReportingLandingPagesGetResponsesContentApplicationJsonSchemaLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/30ReportingLandingPagesGetResponsesContentApplicationJsonSchemaLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"30ReportingLandingPagesGetResponsesContentApplicationJsonSchemaLinksItems"},"LandingPageReportLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"LandingPageReportLinksItemsMethod"},"LandingPageReportLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/LandingPageReportLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"LandingPageReportLinksItems"},"LandingPageReportEcommerce":{"type":"object","properties":{"average_order_revenue":{"type":"number","format":"double","description":"The average order revenue of this landing page."},"currency_code":{"type":"string","description":"The user's currency code."},"total_orders":{"type":"integer","description":"The total number of orders associated with this landing page."},"total_revenue":{"type":"number","format":"double","description":"The total revenue of this landing page."}},"title":"LandingPageReportEcommerce"},"LandingPageReportSignupTagsItems":{"type":"object","properties":{"tag_id":{"type":"integer","description":"The unique id for the tag."},"tag_name":{"type":"string","description":"The name of the tag."}},"title":"LandingPageReportSignupTagsItems"},"LandingPageReportTimeseriesDailyStatsClicksItems":{"type":"object","properties":{"date":{"type":"string"},"val":{"type":"integer"}},"title":"LandingPageReportTimeseriesDailyStatsClicksItems"},"LandingPageReportTimeseriesDailyStatsUniqueVisitsItems":{"type":"object","properties":{"date":{"type":"string"},"val":{"type":"integer"}},"title":"LandingPageReportTimeseriesDailyStatsUniqueVisitsItems"},"LandingPageReportTimeseriesDailyStatsVisitsItems":{"type":"object","properties":{"date":{"type":"string"},"val":{"type":"integer"}},"title":"LandingPageReportTimeseriesDailyStatsVisitsItems"},"LandingPageReportTimeseriesDailyStats":{"type":"object","properties":{"clicks":{"type":"array","items":{"$ref":"#/components/schemas/LandingPageReportTimeseriesDailyStatsClicksItems"}},"unique_visits":{"type":"array","items":{"$ref":"#/components/schemas/LandingPageReportTimeseriesDailyStatsUniqueVisitsItems"}},"visits":{"type":"array","items":{"$ref":"#/components/schemas/LandingPageReportTimeseriesDailyStatsVisitsItems"}}},"description":"The clicks and visits data from the last seven days.","title":"LandingPageReportTimeseriesDailyStats"},"LandingPageReportTimeseriesWeeklyStatsClicksItems":{"type":"object","properties":{"date":{"type":"string"},"val":{"type":"integer"}},"title":"LandingPageReportTimeseriesWeeklyStatsClicksItems"},"LandingPageReportTimeseriesWeeklyStatsUniqueVisitsItems":{"type":"object","properties":{"date":{"type":"string"},"val":{"type":"integer"}},"title":"LandingPageReportTimeseriesWeeklyStatsUniqueVisitsItems"},"LandingPageReportTimeseriesWeeklyStatsVisitsItems":{"type":"object","properties":{"date":{"type":"string"},"val":{"type":"integer"}},"title":"LandingPageReportTimeseriesWeeklyStatsVisitsItems"},"LandingPageReportTimeseriesWeeklyStats":{"type":"object","properties":{"clicks":{"type":"array","items":{"$ref":"#/components/schemas/LandingPageReportTimeseriesWeeklyStatsClicksItems"},"description":"The total number of clicks in a week."},"unique_visits":{"type":"array","items":{"$ref":"#/components/schemas/LandingPageReportTimeseriesWeeklyStatsUniqueVisitsItems"}},"visits":{"type":"array","items":{"$ref":"#/components/schemas/LandingPageReportTimeseriesWeeklyStatsVisitsItems"},"description":"The total number of visits in a week."}},"description":"The clicks and visits data from the last five weeks.","title":"LandingPageReportTimeseriesWeeklyStats"},"LandingPageReportTimeseries":{"type":"object","properties":{"daily_stats":{"$ref":"#/components/schemas/LandingPageReportTimeseriesDailyStats","description":"The clicks and visits data from the last seven days."},"weekly_stats":{"$ref":"#/components/schemas/LandingPageReportTimeseriesWeeklyStats","description":"The clicks and visits data from the last five weeks."}},"title":"LandingPageReportTimeseries"},"LandingPageReport":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/LandingPageReportLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"clicks":{"type":"integer","description":"The number of clicks to this landing pages."},"conversion_rate":{"type":"number","format":"double","description":"The percentage of people who visited your landing page and were added to your list."},"ecommerce":{"$ref":"#/components/schemas/LandingPageReportEcommerce"},"id":{"type":"string","description":"A string that uniquely identifies this landing page."},"list_id":{"type":"string","description":"The list id connected to this landing page."},"list_name":{"type":"string","description":"List Name"},"name":{"type":"string","description":"The name of this landing page the user will see."},"published_at":{"type":"string","format":"date-time","description":"The time this landing page was published."},"signup_tags":{"type":"array","items":{"$ref":"#/components/schemas/LandingPageReportSignupTagsItems"},"description":"A list of tags associated to the landing page."},"status":{"type":"string","description":"The status of the landing page."},"subscribes":{"type":"integer","description":"The number of subscribes to this landing pages."},"timeseries":{"$ref":"#/components/schemas/LandingPageReportTimeseries"},"title":{"type":"string","description":"The name of the landing page the user's customers will see."},"unique_visits":{"type":"integer","description":"The number of unique visits to this landing pages."},"unpublished_at":{"type":"string","format":"date-time","description":"The time this landing page was unpublished."},"url":{"type":"string","description":"The landing page url."},"visits":{"type":"integer","description":"The number of visits to this landing pages."},"web_id":{"type":"integer","description":"The ID used in the Mailchimp web application."}},"description":"A summary of an individual landing page's settings and content.","title":"LandingPageReport"},"reporting_list-landing-pages_Response_200":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/30ReportingLandingPagesGetResponsesContentApplicationJsonSchemaLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"landing_pages":{"type":"array","items":{"$ref":"#/components/schemas/LandingPageReport"}},"total_items":{"type":"integer","description":"The total number of items matching the query regardless of pagination."}},"description":"A collection of landing pages.","title":"reporting_list-landing-pages_Response_200"},"30ReportingSurveysGetResponsesContentApplicationJsonSchemaLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"30ReportingSurveysGetResponsesContentApplicationJsonSchemaLinksItemsMethod"},"30ReportingSurveysGetResponsesContentApplicationJsonSchemaLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/30ReportingSurveysGetResponsesContentApplicationJsonSchemaLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"30ReportingSurveysGetResponsesContentApplicationJsonSchemaLinksItems"},"30ReportingSurveysGetResponsesContentApplicationJsonSchemaSurveysItemsStatus":{"type":"string","enum":["published","unpublished"],"description":"The survey's status.","title":"30ReportingSurveysGetResponsesContentApplicationJsonSchemaSurveysItemsStatus"},"30ReportingSurveysGetResponsesContentApplicationJsonSchemaSurveysItems":{"type":"object","properties":{"created_at":{"type":"string","format":"date-time","description":"The date and time the survey was created in ISO 8601 format."},"id":{"type":"string","description":"A string that uniquely identifies this survey."},"list_id":{"type":"string","description":"The ID of the list connected to this survey."},"list_name":{"type":"string","description":"The name of the list connected to this survey."},"published_at":{"type":"string","format":"date-time","description":"The date and time the survey was published in ISO 8601 format."},"status":{"$ref":"#/components/schemas/30ReportingSurveysGetResponsesContentApplicationJsonSchemaSurveysItemsStatus","description":"The survey's status."},"title":{"type":"string","description":"The title of the survey."},"total_responses":{"type":"integer","description":"The total number of responses to this survey."},"updated_at":{"type":"string","format":"date-time","description":"The date and time the survey was last updated in ISO 8601 format."},"url":{"type":"string","description":"The URL for the survey."},"web_id":{"type":"integer","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}`."}},"description":"The report for a survey.","title":"30ReportingSurveysGetResponsesContentApplicationJsonSchemaSurveysItems"},"reporting_list-surveys_Response_200":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/30ReportingSurveysGetResponsesContentApplicationJsonSchemaLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"surveys":{"type":"array","items":{"$ref":"#/components/schemas/30ReportingSurveysGetResponsesContentApplicationJsonSchemaSurveysItems"},"description":"The surveys that have reports available."},"total_items":{"type":"integer","description":"The total number of items matching the query regardless of pagination."}},"title":"reporting_list-surveys_Response_200"},"30ReportingSurveysSurveyIdGetResponsesContentApplicationJsonSchemaStatus":{"type":"string","enum":["published","unpublished"],"description":"The survey's status.","title":"30ReportingSurveysSurveyIdGetResponsesContentApplicationJsonSchemaStatus"},"reporting_get-survey_Response_200":{"type":"object","properties":{"created_at":{"type":"string","format":"date-time","description":"The date and time the survey was created in ISO 8601 format."},"id":{"type":"string","description":"A string that uniquely identifies this survey."},"list_id":{"type":"string","description":"The ID of the list connected to this survey."},"list_name":{"type":"string","description":"The name of the list connected to this survey."},"published_at":{"type":"string","format":"date-time","description":"The date and time the survey was published in ISO 8601 format."},"status":{"$ref":"#/components/schemas/30ReportingSurveysSurveyIdGetResponsesContentApplicationJsonSchemaStatus","description":"The survey's status."},"title":{"type":"string","description":"The title of the survey."},"total_responses":{"type":"integer","description":"The total number of responses to this survey."},"updated_at":{"type":"string","format":"date-time","description":"The date and time the survey was last updated in ISO 8601 format."},"url":{"type":"string","description":"The URL for the survey."},"web_id":{"type":"integer","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}`."}},"description":"The report for a survey.","title":"reporting_get-survey_Response_200"},"30ReportingSurveysSurveyIdQuestionsGetResponsesContentApplicationJsonSchemaLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"30ReportingSurveysSurveyIdQuestionsGetResponsesContentApplicationJsonSchemaLinksItemsMethod"},"30ReportingSurveysSurveyIdQuestionsGetResponsesContentApplicationJsonSchemaLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/30ReportingSurveysSurveyIdQuestionsGetResponsesContentApplicationJsonSchemaLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"30ReportingSurveysSurveyIdQuestionsGetResponsesContentApplicationJsonSchemaLinksItems"},"SurveyQuestionReportContactCounts":{"type":"object","properties":{"known":{"type":"integer","description":"The number of known contacts that responded to this survey."},"new":{"type":"integer","description":"The number of new contacts that responded to this survey."},"unknown":{"type":"integer","description":"The number of unknown contacts that responded to this survey."}},"description":"For email question types, how many are new, known, or unknown contacts.","title":"SurveyQuestionReportContactCounts"},"SurveyQuestionReportMergeFieldType":{"type":"string","enum":["text","number","address","phone","date","url","imageurl","radio","dropdown","birthday","zip"],"description":"The [type](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for the merge field.","title":"SurveyQuestionReportMergeFieldType"},"SurveyQuestionReportMergeField":{"type":"object","properties":{"id":{"type":"integer","description":"An unchanging id for the merge field."},"label":{"type":"string","description":"The [label](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for the merge field."},"type":{"$ref":"#/components/schemas/SurveyQuestionReportMergeFieldType","description":"The [type](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for the merge field."}},"description":"A [merge field](https://mailchimp.com/developer/marketing/docs/merge-fields/) for an audience.","title":"SurveyQuestionReportMergeField"},"SurveyQuestionReportOptionsItems":{"type":"object","properties":{"count":{"type":"integer","description":"The count of responses that selected this survey question option."},"id":{"type":"string","description":"The ID for this survey question option."},"label":{"type":"string","description":"The label for this survey question option."}},"title":"SurveyQuestionReportOptionsItems"},"SurveyQuestionReportType":{"type":"string","enum":["pickOne","pickMany","range","text","email","contactInformation","dropdown"],"description":"The response type of the survey question.","title":"SurveyQuestionReportType"},"SurveyQuestionReport":{"type":"object","properties":{"average_rating":{"type":"string","title":"float","description":"The average rating for this range question."},"contact_counts":{"$ref":"#/components/schemas/SurveyQuestionReportContactCounts","description":"For email question types, how many are new, known, or unknown contacts."},"has_other":{"type":"boolean","description":"Whether this survey question has an 'other' option."},"id":{"type":"string","description":"The ID of the survey question."},"is_required":{"type":"boolean","description":"Whether this survey question is required to answer."},"merge_field":{"$ref":"#/components/schemas/SurveyQuestionReportMergeField","description":"A [merge field](https://mailchimp.com/developer/marketing/docs/merge-fields/) for an audience."},"options":{"type":"array","items":{"$ref":"#/components/schemas/SurveyQuestionReportOptionsItems"},"description":"The answer choices for this question."},"other_label":{"type":"string","description":"Label used for the 'other' option of this survey question."},"placeholder_label":{"type":"string","description":"Placeholder text for this survey question's answer box."},"query":{"type":"string","description":"The query of the survey question."},"range_high_label":{"type":"string","description":"Label for the high end of the range."},"range_low_label":{"type":"string","description":"Label for the low end of the range."},"subscribe_checkbox_enabled":{"type":"boolean","description":"Whether the subscribe checkbox is shown for this email question."},"subscribe_checkbox_label":{"type":"string","description":"Label used for the subscribe checkbox for this email question."},"survey_id":{"type":"string","description":"The unique ID of the survey."},"total_responses":{"type":"integer","description":"The total number of responses to this question."},"type":{"$ref":"#/components/schemas/SurveyQuestionReportType","description":"The response type of the survey question."}},"description":"The details of a survey question's report.","title":"SurveyQuestionReport"},"reporting_list-survey-questions_Response_200":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/30ReportingSurveysSurveyIdQuestionsGetResponsesContentApplicationJsonSchemaLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"questions":{"type":"array","items":{"$ref":"#/components/schemas/SurveyQuestionReport"},"description":"An array of reports for each question on the survey."},"total_items":{"type":"integer","description":"The total number of items matching the query regardless of pagination."}},"title":"reporting_list-survey-questions_Response_200"},"30ReportingSurveysSurveyIdQuestionsQuestionIdAnswersGetParametersRespondentFamiliarityIs":{"type":"string","enum":["new","known","unknown"],"title":"30ReportingSurveysSurveyIdQuestionsQuestionIdAnswersGetParametersRespondentFamiliarityIs"},"30ReportingSurveysSurveyIdQuestionsQuestionIdAnswersGetResponsesContentApplicationJsonSchemaLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"30ReportingSurveysSurveyIdQuestionsQuestionIdAnswersGetResponsesContentApplicationJsonSchemaLinksItemsMethod"},"30ReportingSurveysSurveyIdQuestionsQuestionIdAnswersGetResponsesContentApplicationJsonSchemaLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/30ReportingSurveysSurveyIdQuestionsQuestionIdAnswersGetResponsesContentApplicationJsonSchemaLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"30ReportingSurveysSurveyIdQuestionsQuestionIdAnswersGetResponsesContentApplicationJsonSchemaLinksItems"},"30ReportingSurveysSurveyIdQuestionsQuestionIdAnswersGetResponsesContentApplicationJsonSchemaAnswersItemsContactStatus":{"type":"string","enum":["Subscribed","Unsubscribed","Non-Subscribed","Cleaned","Archived"],"description":"The contact's current status.","title":"30ReportingSurveysSurveyIdQuestionsQuestionIdAnswersGetResponsesContentApplicationJsonSchemaAnswersItemsContactStatus"},"30ReportingSurveysSurveyIdQuestionsQuestionIdAnswersGetResponsesContentApplicationJsonSchemaAnswersItemsContact":{"type":"object","properties":{"avatar_url":{"type":"string","description":"URL for the contact's avatar or profile image."},"consents_to_one_to_one_messaging":{"type":"boolean","description":"Indicates whether a contact consents to 1:1 messaging."},"contact_id":{"type":"string","description":"The ID of this contact."},"email":{"type":"string","description":"The contact's email address."},"email_id":{"type":"string","description":"The MD5 hash of the lowercase version of the list member's email address."},"full_name":{"type":"string","description":"The contact's full name."},"phone":{"type":"string","description":"The contact's sms phone number."},"status":{"$ref":"#/components/schemas/30ReportingSurveysSurveyIdQuestionsQuestionIdAnswersGetResponsesContentApplicationJsonSchemaAnswersItemsContactStatus","description":"The contact's current status."}},"description":"Information about the contact.","title":"30ReportingSurveysSurveyIdQuestionsQuestionIdAnswersGetResponsesContentApplicationJsonSchemaAnswersItemsContact"},"30ReportingSurveysSurveyIdQuestionsQuestionIdAnswersGetResponsesContentApplicationJsonSchemaAnswersItems":{"type":"object","properties":{"contact":{"$ref":"#/components/schemas/30ReportingSurveysSurveyIdQuestionsQuestionIdAnswersGetResponsesContentApplicationJsonSchemaAnswersItemsContact","description":"Information about the contact."},"id":{"type":"string","description":"The ID of the answer."},"is_new_contact":{"type":"boolean","description":"If this contact was added to the Mailchimp audience via this survey."},"response_id":{"type":"string","description":"The ID of the survey response."},"submitted_at":{"type":"string","format":"date-time","description":"The date and time when the survey response was submitted in ISO 8601 format."},"value":{"type":"string","description":"The raw text answer."}},"description":"The details of a survey question's answer.","title":"30ReportingSurveysSurveyIdQuestionsQuestionIdAnswersGetResponsesContentApplicationJsonSchemaAnswersItems"},"reporting_list-survey-question-answers_Response_200":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/30ReportingSurveysSurveyIdQuestionsQuestionIdAnswersGetResponsesContentApplicationJsonSchemaLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"answers":{"type":"array","items":{"$ref":"#/components/schemas/30ReportingSurveysSurveyIdQuestionsQuestionIdAnswersGetResponsesContentApplicationJsonSchemaAnswersItems"},"description":"An array of answers for a question on the survey."},"total_items":{"type":"integer","description":"The total number of items matching the query regardless of pagination."}},"title":"reporting_list-survey-question-answers_Response_200"},"30ReportingSurveysSurveyIdResponsesGetParametersRespondentFamiliarityIs":{"type":"string","enum":["new","known","unknown"],"title":"30ReportingSurveysSurveyIdResponsesGetParametersRespondentFamiliarityIs"},"30ReportingSurveysSurveyIdResponsesGetResponsesContentApplicationJsonSchemaLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"30ReportingSurveysSurveyIdResponsesGetResponsesContentApplicationJsonSchemaLinksItemsMethod"},"30ReportingSurveysSurveyIdResponsesGetResponsesContentApplicationJsonSchemaLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/30ReportingSurveysSurveyIdResponsesGetResponsesContentApplicationJsonSchemaLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"30ReportingSurveysSurveyIdResponsesGetResponsesContentApplicationJsonSchemaLinksItems"},"30ReportingSurveysSurveyIdResponsesGetResponsesContentApplicationJsonSchemaResponsesItemsContactStatus":{"type":"string","enum":["Subscribed","Unsubscribed","Non-Subscribed","Cleaned","Archived"],"description":"The contact's current status.","title":"30ReportingSurveysSurveyIdResponsesGetResponsesContentApplicationJsonSchemaResponsesItemsContactStatus"},"30ReportingSurveysSurveyIdResponsesGetResponsesContentApplicationJsonSchemaResponsesItemsContact":{"type":"object","properties":{"avatar_url":{"type":"string","description":"URL for the contact's avatar or profile image."},"consents_to_one_to_one_messaging":{"type":"boolean","description":"Indicates whether a contact consents to 1:1 messaging."},"contact_id":{"type":"string","description":"The ID of this contact."},"email":{"type":"string","description":"The contact's email address."},"email_id":{"type":"string","description":"The MD5 hash of the lowercase version of the list member's email address."},"full_name":{"type":"string","description":"The contact's full name."},"phone":{"type":"string","description":"The contact's sms phone number."},"status":{"$ref":"#/components/schemas/30ReportingSurveysSurveyIdResponsesGetResponsesContentApplicationJsonSchemaResponsesItemsContactStatus","description":"The contact's current status."}},"description":"Information about the contact.","title":"30ReportingSurveysSurveyIdResponsesGetResponsesContentApplicationJsonSchemaResponsesItemsContact"},"30ReportingSurveysSurveyIdResponsesGetResponsesContentApplicationJsonSchemaResponsesItems":{"type":"object","properties":{"contact":{"$ref":"#/components/schemas/30ReportingSurveysSurveyIdResponsesGetResponsesContentApplicationJsonSchemaResponsesItemsContact","description":"Information about the contact."},"is_new_contact":{"type":"boolean","description":"If this contact was added to the Mailchimp audience via this survey."},"response_id":{"type":"string","description":"The ID for the survey response."},"submitted_at":{"type":"string","format":"date-time","description":"The date and time when the survey response was submitted in ISO 8601 format."}},"description":"Survey respondent details.","title":"30ReportingSurveysSurveyIdResponsesGetResponsesContentApplicationJsonSchemaResponsesItems"},"reporting_list-survey-responses_Response_200":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/30ReportingSurveysSurveyIdResponsesGetResponsesContentApplicationJsonSchemaLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"responses":{"type":"array","items":{"$ref":"#/components/schemas/30ReportingSurveysSurveyIdResponsesGetResponsesContentApplicationJsonSchemaResponsesItems"},"description":"An array of responses to a survey."},"total_items":{"type":"integer","description":"The total number of items matching the query regardless of pagination."}},"title":"reporting_list-survey-responses_Response_200"},"30ReportingSurveysSurveyIdResponsesResponseIdGetResponsesContentApplicationJsonSchemaContactStatus":{"type":"string","enum":["Subscribed","Unsubscribed","Non-Subscribed","Cleaned","Archived"],"description":"The contact's current status.","title":"30ReportingSurveysSurveyIdResponsesResponseIdGetResponsesContentApplicationJsonSchemaContactStatus"},"30ReportingSurveysSurveyIdResponsesResponseIdGetResponsesContentApplicationJsonSchemaContact":{"type":"object","properties":{"avatar_url":{"type":"string","description":"URL for the contact's avatar or profile image."},"consents_to_one_to_one_messaging":{"type":"boolean","description":"Indicates whether a contact consents to 1:1 messaging."},"contact_id":{"type":"string","description":"The ID of this contact."},"email":{"type":"string","description":"The contact's email address."},"email_id":{"type":"string","description":"The MD5 hash of the lowercase version of the list member's email address."},"full_name":{"type":"string","description":"The contact's full name."},"phone":{"type":"string","description":"The contact's sms phone number."},"status":{"$ref":"#/components/schemas/30ReportingSurveysSurveyIdResponsesResponseIdGetResponsesContentApplicationJsonSchemaContactStatus","description":"The contact's current status."}},"description":"Information about the contact.","title":"30ReportingSurveysSurveyIdResponsesResponseIdGetResponsesContentApplicationJsonSchemaContact"},"30ReportingSurveysSurveyIdResponsesResponseIdGetResponsesContentApplicationJsonSchemaResultsItemsQuestionType":{"type":"string","enum":["pickOne","pickMany","range","text","email","contactInformation","dropdown"],"description":"The type of question this is.","title":"30ReportingSurveysSurveyIdResponsesResponseIdGetResponsesContentApplicationJsonSchemaResultsItemsQuestionType"},"30ReportingSurveysSurveyIdResponsesResponseIdGetResponsesContentApplicationJsonSchemaResultsItems":{"type":"object","properties":{"answer":{"type":"string","description":"The answer to this survey question."},"query":{"type":"string","description":"The survey question."},"question_id":{"type":"string","description":"The unique ID for this question."},"question_type":{"$ref":"#/components/schemas/30ReportingSurveysSurveyIdResponsesResponseIdGetResponsesContentApplicationJsonSchemaResultsItemsQuestionType","description":"The type of question this is."}},"description":"A single question and the response to that question.","title":"30ReportingSurveysSurveyIdResponsesResponseIdGetResponsesContentApplicationJsonSchemaResultsItems"},"reporting_get-survey-respons_Response_200":{"type":"object","properties":{"contact":{"$ref":"#/components/schemas/30ReportingSurveysSurveyIdResponsesResponseIdGetResponsesContentApplicationJsonSchemaContact","description":"Information about the contact."},"is_new_contact":{"type":"boolean","description":"If this contact was added to the Mailchimp audience via this survey."},"response_id":{"type":"string","description":"The ID for the survey response."},"results":{"type":"array","items":{"$ref":"#/components/schemas/30ReportingSurveysSurveyIdResponsesResponseIdGetResponsesContentApplicationJsonSchemaResultsItems"},"description":"The survey questions and the answers to those questions."},"submitted_at":{"type":"string","format":"date-time","description":"The date and time when the survey response was submitted in ISO 8601 format."}},"description":"A single survey response.","title":"reporting_get-survey-respons_Response_200"},"30ReportsGetParametersType":{"type":"string","enum":["regular","plaintext","absplit","rss","variate"],"title":"30ReportsGetParametersType"},"30ReportsGetResponsesContentApplicationJsonSchemaLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"30ReportsGetResponsesContentApplicationJsonSchemaLinksItemsMethod"},"30ReportsGetResponsesContentApplicationJsonSchemaLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/30ReportsGetResponsesContentApplicationJsonSchemaLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"30ReportsGetResponsesContentApplicationJsonSchemaLinksItems"},"CampaignReportLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"CampaignReportLinksItemsMethod"},"CampaignReportLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/CampaignReportLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"CampaignReportLinksItems"},"CampaignReportAbSplitA":{"type":"object","properties":{"abuse_reports":{"type":"integer","description":"Abuse reports for Campaign A."},"bounces":{"type":"integer","description":"Bounces for Campaign A."},"forwards":{"type":"integer","description":"Forwards for Campaign A."},"forwards_opens":{"type":"integer","description":"Opens from forwards for Campaign A."},"last_open":{"type":"string","description":"The last open for Campaign A."},"opens":{"type":"integer","description":"Opens for Campaign A."},"recipient_clicks":{"type":"integer","description":"Recipient Clicks for Campaign A."},"unique_opens":{"type":"integer","description":"Unique opens for Campaign A."},"unsubs":{"type":"integer","description":"Unsubscribes for Campaign A."}},"description":"Stats for Campaign A.","title":"CampaignReportAbSplitA"},"CampaignReportAbSplitB":{"type":"object","properties":{"abuse_reports":{"type":"integer","description":"Abuse reports for Campaign B."},"bounces":{"type":"integer","description":"Bounces for Campaign B."},"forwards":{"type":"integer","description":"Forwards for Campaign B."},"forwards_opens":{"type":"integer","description":"Opens for forwards from Campaign B."},"last_open":{"type":"string","description":"The last open for Campaign B."},"opens":{"type":"integer","description":"Opens for Campaign B."},"recipient_clicks":{"type":"integer","description":"Recipients clicks for Campaign B."},"unique_opens":{"type":"integer","description":"Unique opens for Campaign B."},"unsubs":{"type":"integer","description":"Unsubscribes for Campaign B."}},"description":"Stats for Campaign B.","title":"CampaignReportAbSplitB"},"CampaignReportAbSplit":{"type":"object","properties":{"a":{"$ref":"#/components/schemas/CampaignReportAbSplitA","description":"Stats for Campaign A."},"b":{"$ref":"#/components/schemas/CampaignReportAbSplitB","description":"Stats for Campaign B."}},"description":"General stats about different groups of an A/B Split campaign. Does not return information about Multivariate Campaigns.","title":"CampaignReportAbSplit"},"CampaignReportBounces":{"type":"object","properties":{"hard_bounces":{"type":"integer","description":"The total number of hard bounced email addresses."},"soft_bounces":{"type":"integer","description":"The total number of soft bounced email addresses."},"syntax_errors":{"type":"integer","description":"The total number of addresses that were syntax-related bounces."}},"description":"An object describing the bounce summary for the campaign.","title":"CampaignReportBounces"},"CampaignReportClicks":{"type":"object","properties":{"click_rate":{"type":"number","format":"double","description":"The number of unique clicks divided by the total number of successful deliveries."},"clicks_total":{"type":"integer","description":"The total number of clicks for the campaign."},"last_click":{"type":"string","format":"date-time","description":"The date and time of the last recorded click for the campaign in ISO 8601 format."},"unique_clicks":{"type":"integer","description":"The total number of unique clicks for links across a campaign."},"unique_subscriber_clicks":{"type":"integer","description":"The total number of subscribers who clicked on a campaign."}},"description":"An object describing the click activity for the campaign.","title":"CampaignReportClicks"},"CampaignReportDeliveryStatusStatus":{"type":"string","enum":["delivering","delivered","canceling","canceled"],"description":"The current state of a campaign delivery.","title":"CampaignReportDeliveryStatusStatus"},"CampaignReportDeliveryStatus":{"type":"object","properties":{"can_cancel":{"type":"boolean","description":"Whether a campaign send can be canceled."},"emails_canceled":{"type":"integer","description":"The total number of emails canceled for this campaign."},"emails_sent":{"type":"integer","description":"The total number of emails confirmed sent for this campaign so far."},"enabled":{"type":"boolean","description":"Whether Campaign Delivery Status is enabled for this account and campaign."},"status":{"$ref":"#/components/schemas/CampaignReportDeliveryStatusStatus","description":"The current state of a campaign delivery."}},"description":"Updates on campaigns in the process of sending.","title":"CampaignReportDeliveryStatus"},"CampaignReportEcommerce":{"type":"object","properties":{"currency_code":{"type":"string"},"total_orders":{"type":"integer","description":"The total orders for a campaign."},"total_revenue":{"type":"number","format":"double","description":"The total revenue for a campaign. Calculated as the sum of all order totals minus shipping and tax totals."},"total_spent":{"type":"number","format":"double","description":"The total spent for a campaign. Calculated as the sum of all order totals with no deductions."}},"description":"E-Commerce stats for a campaign.","title":"CampaignReportEcommerce"},"CampaignReportFacebookLikes":{"type":"object","properties":{"facebook_likes":{"type":"integer","description":"The number of Facebook likes for the campaign."},"recipient_likes":{"type":"integer","description":"The number of recipients who liked the campaign on Facebook."},"unique_likes":{"type":"integer","description":"The number of unique likes."}},"description":"An object describing campaign engagement on Facebook.","title":"CampaignReportFacebookLikes"},"CampaignReportForwards":{"type":"object","properties":{"forwards_count":{"type":"integer","description":"How many times the campaign has been forwarded."},"forwards_opens":{"type":"integer","description":"How many times the forwarded campaign has been opened."}},"description":"An object describing the forwards and forward activity for the campaign.","title":"CampaignReportForwards"},"CampaignReportIndustryStats":{"type":"object","properties":{"abuse_rate":{"type":"number","format":"double","description":"The industry abuse rate."},"bounce_rate":{"type":"number","format":"double","description":"The industry bounce rate."},"click_rate":{"type":"number","format":"double","description":"The industry click rate."},"open_rate":{"type":"number","format":"double","description":"The industry open rate."},"type":{"type":"string","description":"The type of business industry associated with your account. For example: retail, education, etc."},"unopen_rate":{"type":"number","format":"double","description":"The industry unopened rate."},"unsub_rate":{"type":"number","format":"double","description":"The industry unsubscribe rate."}},"description":"The average campaign statistics for your industry.","title":"CampaignReportIndustryStats"},"CampaignReportListStats":{"type":"object","properties":{"click_rate":{"type":"number","format":"double","description":"The average click rate (a percentage represented as a number between 0 and 100) per campaign for the list."},"open_rate":{"type":"number","format":"double","description":"The average unique open rate (a percentage represented as a number between 0 and 100) per campaign for the list."},"proxy_excluded_open_rate":{"type":"number","format":"double","description":"The average unique open rate (a percentage represented as a number between 0 and 100) per campaign for the list, excluding opens from email clients that use proxies."},"sub_rate":{"type":"number","format":"double","description":"The average number of subscriptions per month for the list."},"unsub_rate":{"type":"number","format":"double","description":"The average number of unsubscriptions per month for the list."}},"description":"The average campaign statistics for your list. This won't be present if we haven't calculated it yet for this list.","title":"CampaignReportListStats"},"CampaignReportOpens":{"type":"object","properties":{"last_open":{"type":"string","format":"date-time","description":"The date and time of the last recorded open in ISO 8601 format."},"open_rate":{"type":"number","format":"double","description":"The number of unique opens for a campaign divided by the total number of successful deliveries."},"opens_total":{"type":"integer","description":"The total number of opens for a campaign."},"proxy_excluded_open_rate":{"type":"number","format":"double","description":"The average unique open rate for a campaign, excluding opens from email clients that use proxies."},"proxy_excluded_opens":{"type":"integer","description":"The total number of opens for a campaign, excluding opens from email clients that use proxies."},"proxy_excluded_unique_opens":{"type":"integer","description":"The total number of unique opens for a campaign, excluding opens from email clients that use proxies."},"unique_opens":{"type":"integer","description":"The total number of unique opens for a campaign."}},"description":"An object describing the open activity for the campaign.","title":"CampaignReportOpens"},"CampaignReportShareReport":{"type":"object","properties":{"share_password":{"type":"string","description":"If password protected, the password for the VIP report."},"share_url":{"type":"string","description":"The URL for the VIP report."}},"description":"The url and password for the [VIP report](https://mailchimp.com/help/share-a-campaign-report/).","title":"CampaignReportShareReport"},"CampaignReportTimeseriesItems":{"type":"object","properties":{"emails_sent":{"type":"integer","description":"The number of emails sent in the timeseries."},"proxy_excluded_unique_opens":{"type":"integer","description":"The number of unique opens in the timeseries, excluding opens from email clients that use proxies."},"recipients_clicks":{"type":"integer","description":"The number of clicks in the timeseries."},"timestamp":{"type":"string","format":"date-time","description":"The date and time for the series in ISO 8601 format."},"unique_opens":{"type":"integer","description":"The number of unique opens in the timeseries."}},"title":"CampaignReportTimeseriesItems"},"CampaignReportTimewarpItems":{"type":"object","properties":{"bounces":{"type":"integer","description":"The number of bounces."},"clicks":{"type":"integer","description":"The number of clicks."},"gmt_offset":{"type":"integer","description":"For campaigns sent with timewarp, the time zone group the member is apart of."},"last_click":{"type":"string","format":"date-time","description":"The date and time of the last click in ISO 8601 format."},"last_open":{"type":"string","format":"date-time","description":"The date and time of the last open in ISO 8601 format."},"opens":{"type":"integer","description":"The number of opens."},"unique_clicks":{"type":"integer","description":"The number of unique clicks."},"unique_opens":{"type":"integer","description":"The number of unique opens."}},"title":"CampaignReportTimewarpItems"},"CampaignReport":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/CampaignReportLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"ab_split":{"$ref":"#/components/schemas/CampaignReportAbSplit","description":"General stats about different groups of an A/B Split campaign. Does not return information about Multivariate Campaigns."},"abuse_reports":{"type":"integer","description":"The number of abuse reports generated for this campaign."},"bounces":{"$ref":"#/components/schemas/CampaignReportBounces","description":"An object describing the bounce summary for the campaign."},"campaign_title":{"type":"string","description":"The title of the campaign."},"clicks":{"$ref":"#/components/schemas/CampaignReportClicks","description":"An object describing the click activity for the campaign."},"delivery_status":{"$ref":"#/components/schemas/CampaignReportDeliveryStatus","description":"Updates on campaigns in the process of sending."},"ecommerce":{"$ref":"#/components/schemas/CampaignReportEcommerce","description":"E-Commerce stats for a campaign."},"emails_sent":{"type":"integer","description":"The total number of emails sent for this campaign."},"facebook_likes":{"$ref":"#/components/schemas/CampaignReportFacebookLikes","description":"An object describing campaign engagement on Facebook."},"forwards":{"$ref":"#/components/schemas/CampaignReportForwards","description":"An object describing the forwards and forward activity for the campaign."},"id":{"type":"string","description":"A string that uniquely identifies this campaign."},"industry_stats":{"$ref":"#/components/schemas/CampaignReportIndustryStats","description":"The average campaign statistics for your industry."},"list_id":{"type":"string","description":"The unique list id."},"list_is_active":{"type":"boolean","description":"The status of the list used, namely if it's deleted or disabled."},"list_name":{"type":"string","description":"The name of the list."},"list_stats":{"$ref":"#/components/schemas/CampaignReportListStats","description":"The average campaign statistics for your list. This won't be present if we haven't calculated it yet for this list."},"opens":{"$ref":"#/components/schemas/CampaignReportOpens","description":"An object describing the open activity for the campaign."},"preview_text":{"type":"string","description":"The preview text for the campaign."},"rss_last_send":{"type":"string","format":"date-time","description":"For RSS campaigns, the date and time of the last send in ISO 8601 format."},"send_time":{"type":"string","format":"date-time","description":"The date and time a campaign was sent in ISO 8601 format."},"share_report":{"$ref":"#/components/schemas/CampaignReportShareReport","description":"The url and password for the [VIP report](https://mailchimp.com/help/share-a-campaign-report/)."},"subject_line":{"type":"string","description":"The subject line for the campaign."},"timeseries":{"type":"array","items":{"$ref":"#/components/schemas/CampaignReportTimeseriesItems"},"description":"An hourly breakdown of the performance of the campaign over the first 24 hours."},"timewarp":{"type":"array","items":{"$ref":"#/components/schemas/CampaignReportTimewarpItems"},"description":"An hourly breakdown of sends, opens, and clicks if a campaign is sent using timewarp."},"type":{"type":"string","description":"The type of campaign (regular, plain-text, ab_split, rss, automation, variate, or auto)."},"unsubscribed":{"type":"integer","description":"The total number of unsubscribed members for this campaign."}},"description":"Report details about a sent campaign.","title":"CampaignReport"},"reports_list_Response_200":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/30ReportsGetResponsesContentApplicationJsonSchemaLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"reports":{"type":"array","items":{"$ref":"#/components/schemas/CampaignReport"},"description":"An array of objects, each representing a report resource."},"total_items":{"type":"integer","description":"The total number of items matching the query regardless of pagination."}},"description":"A list of reports containing campaigns marked as Sent.","title":"reports_list_Response_200"},"30ReportsCampaignIdAbuseReportsGetResponsesContentApplicationJsonSchemaLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"30ReportsCampaignIdAbuseReportsGetResponsesContentApplicationJsonSchemaLinksItemsMethod"},"30ReportsCampaignIdAbuseReportsGetResponsesContentApplicationJsonSchemaLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/30ReportsCampaignIdAbuseReportsGetResponsesContentApplicationJsonSchemaLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"30ReportsCampaignIdAbuseReportsGetResponsesContentApplicationJsonSchemaLinksItems"},"AbuseComplaintLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"AbuseComplaintLinksItemsMethod"},"AbuseComplaintLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/AbuseComplaintLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"AbuseComplaintLinksItems"},"AbuseComplaintMergeFields0":{"type":"object","properties":{"addr1":{"type":"string"},"addr2":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"zip":{"type":"string"},"country":{"type":"string"}},"required":["addr1","city","state","zip"],"title":"AbuseComplaintMergeFields0"},"AbuseComplaintMergeFields":{"oneOf":[{"$ref":"#/components/schemas/AbuseComplaintMergeFields0"},{"type":"string"},{"type":"number","format":"double"}],"description":"This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field.","title":"AbuseComplaintMergeFields"},"AbuseComplaint":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/AbuseComplaintLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"campaign_id":{"type":"string","description":"The campaign id for the abuse report"},"date":{"type":"string","format":"date-time","description":"Date for the abuse report"},"email_address":{"type":"string","description":"Email address for a subscriber."},"email_id":{"type":"string","description":"The MD5 hash of the lowercase version of the list member's email address."},"id":{"type":"integer","description":"The id for the abuse report"},"list_id":{"type":"string","description":"The unique id of the list for the abuse report."},"list_is_active":{"type":"boolean","description":"The status of the list used, namely if it's deleted or disabled."},"merge_fields":{"type":["object","null"],"additionalProperties":{"$ref":"#/components/schemas/AbuseComplaintMergeFields"},"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."},"vip":{"type":"boolean","description":"[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber."}},"description":"Details of abuse complaints for a specific list. An abuse complaint occurs when your recipient clicks to 'report spam' in their email program.","title":"AbuseComplaint"},"reports_list-abuse-reports_Response_200":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/30ReportsCampaignIdAbuseReportsGetResponsesContentApplicationJsonSchemaLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"abuse_reports":{"type":"array","items":{"$ref":"#/components/schemas/AbuseComplaint"},"description":"An array of objects, each representing an abuse report resource."},"campaign_id":{"type":"string","description":"The campaign id."},"total_items":{"type":"integer","description":"The total number of items matching the query regardless of pagination."}},"description":"A list of abuse complaints for a specific list.","title":"reports_list-abuse-reports_Response_200"},"30ReportsCampaignIdAdviceGetResponsesContentApplicationJsonSchemaLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"30ReportsCampaignIdAdviceGetResponsesContentApplicationJsonSchemaLinksItemsMethod"},"30ReportsCampaignIdAdviceGetResponsesContentApplicationJsonSchemaLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/30ReportsCampaignIdAdviceGetResponsesContentApplicationJsonSchemaLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"30ReportsCampaignIdAdviceGetResponsesContentApplicationJsonSchemaLinksItems"},"30ReportsCampaignIdAdviceGetResponsesContentApplicationJsonSchemaAdviceItemsLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"30ReportsCampaignIdAdviceGetResponsesContentApplicationJsonSchemaAdviceItemsLinksItemsMethod"},"30ReportsCampaignIdAdviceGetResponsesContentApplicationJsonSchemaAdviceItemsLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/30ReportsCampaignIdAdviceGetResponsesContentApplicationJsonSchemaAdviceItemsLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"30ReportsCampaignIdAdviceGetResponsesContentApplicationJsonSchemaAdviceItemsLinksItems"},"30ReportsCampaignIdAdviceGetResponsesContentApplicationJsonSchemaAdviceItemsType":{"type":"string","enum":["negative","positive","neutral"],"description":"The sentiment type for a feedback message.","title":"30ReportsCampaignIdAdviceGetResponsesContentApplicationJsonSchemaAdviceItemsType"},"30ReportsCampaignIdAdviceGetResponsesContentApplicationJsonSchemaAdviceItems":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/30ReportsCampaignIdAdviceGetResponsesContentApplicationJsonSchemaAdviceItemsLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"message":{"type":"string","description":"The advice message."},"type":{"$ref":"#/components/schemas/30ReportsCampaignIdAdviceGetResponsesContentApplicationJsonSchemaAdviceItemsType","description":"The sentiment type for a feedback message."}},"description":"Campaign feedback details.","title":"30ReportsCampaignIdAdviceGetResponsesContentApplicationJsonSchemaAdviceItems"},"reports_list-advice_Response_200":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/30ReportsCampaignIdAdviceGetResponsesContentApplicationJsonSchemaLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"advice":{"type":"array","items":{"$ref":"#/components/schemas/30ReportsCampaignIdAdviceGetResponsesContentApplicationJsonSchemaAdviceItems"},"description":"An array of objects, each representing a point of campaign feedback."},"campaign_id":{"type":"string","description":"The campaign id."},"total_items":{"type":"integer","description":"The total number of items matching the query regardless of pagination."}},"description":"A list of feedback based on a campaign's statistics.","title":"reports_list-advice_Response_200"},"30ReportsCampaignIdClickDetailsGetParametersSortField":{"type":"string","enum":["total_clicks","unique_clicks"],"title":"30ReportsCampaignIdClickDetailsGetParametersSortField"},"30ReportsCampaignIdClickDetailsGetParametersSortDir":{"type":"string","enum":["ASC","DESC"],"title":"30ReportsCampaignIdClickDetailsGetParametersSortDir"},"30ReportsCampaignIdClickDetailsGetResponsesContentApplicationJsonSchemaLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"30ReportsCampaignIdClickDetailsGetResponsesContentApplicationJsonSchemaLinksItemsMethod"},"30ReportsCampaignIdClickDetailsGetResponsesContentApplicationJsonSchemaLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/30ReportsCampaignIdClickDetailsGetResponsesContentApplicationJsonSchemaLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"30ReportsCampaignIdClickDetailsGetResponsesContentApplicationJsonSchemaLinksItems"},"ClickDetailReportLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"ClickDetailReportLinksItemsMethod"},"ClickDetailReportLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/ClickDetailReportLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"ClickDetailReportLinksItems"},"ClickDetailReportAbSplitA":{"type":"object","properties":{"click_percentage_a":{"type":"number","format":"double","description":"The percentage of total clicks for Group A."},"total_clicks_a":{"type":"integer","description":"The total number of clicks for Group A."},"unique_click_percentage_a":{"type":"number","format":"double","description":"The percentage of unique clicks for Group A."},"unique_clicks_a":{"type":"integer","description":"The number of unique clicks for Group A."}},"description":"Stats for Group A.","title":"ClickDetailReportAbSplitA"},"ClickDetailReportAbSplitB":{"type":"object","properties":{"click_percentage_b":{"type":"number","format":"double","description":"The percentage of total clicks for Group B."},"total_clicks_b":{"type":"integer","description":"The total number of clicks for Group B."},"unique_click_percentage_b":{"type":"number","format":"double","description":"The percentage of unique clicks for Group B."},"unique_clicks_b":{"type":"integer","description":"The number of unique clicks for Group B."}},"description":"Stats for Group B.","title":"ClickDetailReportAbSplitB"},"ClickDetailReportAbSplit":{"type":"object","properties":{"a":{"$ref":"#/components/schemas/ClickDetailReportAbSplitA","description":"Stats for Group A."},"b":{"$ref":"#/components/schemas/ClickDetailReportAbSplitB","description":"Stats for Group B."}},"description":"A breakdown of clicks by different groups of an A/B Split campaign. Does not return information about Multivariate Campaigns.","title":"ClickDetailReportAbSplit"},"ClickDetailReport":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/ClickDetailReportLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"ab_split":{"$ref":"#/components/schemas/ClickDetailReportAbSplit","description":"A breakdown of clicks by different groups of an A/B Split campaign. Does not return information about Multivariate Campaigns."},"campaign_id":{"type":"string","description":"The campaign id."},"click_percentage":{"type":"number","format":"double","description":"The percentage of total clicks a link generated for a campaign."},"id":{"type":"string","description":"The unique id for the link."},"last_click":{"type":"string","format":"date-time","description":"The date and time for the last recorded click for a link in ISO 8601 format."},"total_clicks":{"type":"integer","description":"The number of total clicks for a link."},"unique_click_percentage":{"type":"number","format":"double","description":"The percentage of unique clicks a link generated for a campaign."},"unique_clicks":{"type":"integer","description":"Number of unique clicks for a link."},"url":{"type":"string","description":"The URL for the link in the campaign."}},"description":"A report of links clicked in a specific campaign.","title":"ClickDetailReport"},"reports_list-click-details_Response_200":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/30ReportsCampaignIdClickDetailsGetResponsesContentApplicationJsonSchemaLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"campaign_id":{"type":"string","description":"The campaign id."},"total_items":{"type":"integer","description":"The total number of items matching the query regardless of pagination."},"urls_clicked":{"type":"array","items":{"$ref":"#/components/schemas/ClickDetailReport"},"description":"An array of objects, each representing a specific URL contained in the campaign."}},"description":"A list of URLs and unique IDs included in HTML and plain-text versions of a campaign.","title":"reports_list-click-details_Response_200"},"30ReportsCampaignIdClickDetailsLinkIdMembersGetResponsesContentApplicationJsonSchemaLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"30ReportsCampaignIdClickDetailsLinkIdMembersGetResponsesContentApplicationJsonSchemaLinksItemsMethod"},"30ReportsCampaignIdClickDetailsLinkIdMembersGetResponsesContentApplicationJsonSchemaLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/30ReportsCampaignIdClickDetailsLinkIdMembersGetResponsesContentApplicationJsonSchemaLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"30ReportsCampaignIdClickDetailsLinkIdMembersGetResponsesContentApplicationJsonSchemaLinksItems"},"ClickDetailMemberLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"ClickDetailMemberLinksItemsMethod"},"ClickDetailMemberLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/ClickDetailMemberLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"ClickDetailMemberLinksItems"},"ClickDetailMemberMergeFields0":{"type":"object","properties":{"addr1":{"type":"string"},"addr2":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"zip":{"type":"string"},"country":{"type":"string"}},"required":["addr1","city","state","zip"],"title":"ClickDetailMemberMergeFields0"},"ClickDetailMemberMergeFields":{"oneOf":[{"$ref":"#/components/schemas/ClickDetailMemberMergeFields0"},{"type":"string"},{"type":"number","format":"double"}],"description":"This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field.","title":"ClickDetailMemberMergeFields"},"ClickDetailMember":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/ClickDetailMemberLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"campaign_id":{"type":"string","description":"The campaign id."},"clicks":{"type":"integer","description":"The total number of times the subscriber clicked on the link."},"contact_status":{"type":"string","description":"The status of the member, namely if they are subscribed, unsubscribed, deleted, non-subscribed, transactional, pending, or need reconfirmation."},"email_address":{"type":"string","description":"Email address for a subscriber."},"email_id":{"type":"string","description":"The MD5 hash of the lowercase version of the list member's email address."},"list_id":{"type":"string","description":"The list id."},"list_is_active":{"type":"boolean","description":"The status of the list used, namely if it's deleted or disabled."},"merge_fields":{"type":["object","null"],"additionalProperties":{"$ref":"#/components/schemas/ClickDetailMemberMergeFields"},"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."},"url_id":{"type":"string","description":"The id for the tracked URL in the campaign."},"vip":{"type":"boolean","description":"[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber."}},"description":"A subscriber who clicked a specific URL in a specific campaign.","title":"ClickDetailMember"},"reports_list-click-detail-members_Response_200":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/30ReportsCampaignIdClickDetailsLinkIdMembersGetResponsesContentApplicationJsonSchemaLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"campaign_id":{"type":"string","description":"The campaign id."},"members":{"type":"array","items":{"$ref":"#/components/schemas/ClickDetailMember"},"description":"An array of objects, each representing a member who clicked a specific link within a campaign."},"total_items":{"type":"integer","description":"The total number of items matching the query regardless of pagination."}},"description":"A collection of members who clicked on a specific link within a campaign.","title":"reports_list-click-detail-members_Response_200"},"30ReportsCampaignIdDomainPerformanceGetResponsesContentApplicationJsonSchemaLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"30ReportsCampaignIdDomainPerformanceGetResponsesContentApplicationJsonSchemaLinksItemsMethod"},"30ReportsCampaignIdDomainPerformanceGetResponsesContentApplicationJsonSchemaLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/30ReportsCampaignIdDomainPerformanceGetResponsesContentApplicationJsonSchemaLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"30ReportsCampaignIdDomainPerformanceGetResponsesContentApplicationJsonSchemaLinksItems"},"30ReportsCampaignIdDomainPerformanceGetResponsesContentApplicationJsonSchemaDomainsItems":{"type":"object","properties":{"bounces":{"type":"integer","description":"The number of bounces at a domain."},"bounces_pct":{"type":"number","format":"double","description":"The percentage of total bounces from this domain."},"clicks":{"type":"integer","description":"The number of clicks for a domain."},"clicks_pct":{"type":"number","format":"double","description":"The percentage of total clicks from this domain."},"delivered":{"type":"integer","description":"The number of successful deliveries for a domain."},"domain":{"type":"string","description":"The name of the domain (gmail.com, hotmail.com, yahoo.com)."},"emails_pct":{"type":"number","format":"double","description":"The percentage of total emails that went to this domain."},"emails_sent":{"type":"integer","description":"The number of emails sent to that specific domain."},"opens":{"type":"integer","description":"The number of opens for a domain."},"opens_pct":{"type":"number","format":"double","description":"The percentage of total opens from this domain."},"unsubs":{"type":"integer","description":"The total number of unsubscribes for a domain."},"unsubs_pct":{"type":"number","format":"double","description":"The percentage of total unsubscribes from this domain."}},"description":"A single email domain's performance","title":"30ReportsCampaignIdDomainPerformanceGetResponsesContentApplicationJsonSchemaDomainsItems"},"reports_list-domain-performance_Response_200":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/30ReportsCampaignIdDomainPerformanceGetResponsesContentApplicationJsonSchemaLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"campaign_id":{"type":"string","description":"The unique id for the campaign."},"domains":{"type":"array","items":{"$ref":"#/components/schemas/30ReportsCampaignIdDomainPerformanceGetResponsesContentApplicationJsonSchemaDomainsItems"},"description":"The top 5 email domains based on total delivered emails."},"total_items":{"type":"integer","description":"The total number of items matching the query regardless of pagination."},"total_sent":{"type":"integer","description":"The total number of emails sent for the campaign."}},"description":"Statistics for the top-performing email domains in a campaign.","title":"reports_list-domain-performance_Response_200"},"30ReportsCampaignIdEcommerceProductActivityGetParametersSortField":{"type":"string","enum":["title","total_revenue","total_purchased"],"title":"30ReportsCampaignIdEcommerceProductActivityGetParametersSortField"},"30ReportsCampaignIdEcommerceProductActivityGetResponsesContentApplicationJsonSchemaLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"30ReportsCampaignIdEcommerceProductActivityGetResponsesContentApplicationJsonSchemaLinksItemsMethod"},"30ReportsCampaignIdEcommerceProductActivityGetResponsesContentApplicationJsonSchemaLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/30ReportsCampaignIdEcommerceProductActivityGetResponsesContentApplicationJsonSchemaLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"30ReportsCampaignIdEcommerceProductActivityGetResponsesContentApplicationJsonSchemaLinksItems"},"30ReportsCampaignIdEcommerceProductActivityGetResponsesContentApplicationJsonSchemaProductsItems":{"type":"object","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","format":"double"},"total_revenue":{"type":"number","format":"double"}},"title":"30ReportsCampaignIdEcommerceProductActivityGetResponsesContentApplicationJsonSchemaProductsItems"},"reports_list-ecommerce-product-activity_Response_200":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/30ReportsCampaignIdEcommerceProductActivityGetResponsesContentApplicationJsonSchemaLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"products":{"type":"array","items":{"$ref":"#/components/schemas/30ReportsCampaignIdEcommerceProductActivityGetResponsesContentApplicationJsonSchemaProductsItems"}},"total_items":{"type":"integer","description":"The total number of items matching the query regardless of pagination."}},"description":"A collection of ecommerce products.","title":"reports_list-ecommerce-product-activity_Response_200"},"30ReportsCampaignIdEepurlGetResponsesContentApplicationJsonSchemaLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"30ReportsCampaignIdEepurlGetResponsesContentApplicationJsonSchemaLinksItemsMethod"},"30ReportsCampaignIdEepurlGetResponsesContentApplicationJsonSchemaLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/30ReportsCampaignIdEepurlGetResponsesContentApplicationJsonSchemaLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"30ReportsCampaignIdEepurlGetResponsesContentApplicationJsonSchemaLinksItems"},"30ReportsCampaignIdEepurlGetResponsesContentApplicationJsonSchemaClicksLocationsItems":{"type":"object","properties":{"country":{"type":"string","description":"The two-digit country code for a recorded click."},"region":{"type":"string","description":"If available, a specific region where the click was recorded."}},"description":"An individual click location.","title":"30ReportsCampaignIdEepurlGetResponsesContentApplicationJsonSchemaClicksLocationsItems"},"30ReportsCampaignIdEepurlGetResponsesContentApplicationJsonSchemaClicks":{"type":"object","properties":{"clicks":{"type":"integer","description":"The total number of clicks to the campaign's URL."},"first_click":{"type":"string","format":"date-time","description":"The timestamp for the first click to the URL."},"last_click":{"type":"string","format":"date-time","description":"The timestamp for the last click to the URL."},"locations":{"type":"array","items":{"$ref":"#/components/schemas/30ReportsCampaignIdEepurlGetResponsesContentApplicationJsonSchemaClicksLocationsItems"},"description":"A summary of the top click locations."}},"description":"A summary of the click-throughs on the campaign's URL.","title":"30ReportsCampaignIdEepurlGetResponsesContentApplicationJsonSchemaClicks"},"30ReportsCampaignIdEepurlGetResponsesContentApplicationJsonSchemaReferrersItems":{"type":"object","properties":{"clicks":{"type":"integer","description":"The number of clicks a single referrer generated."},"first_click":{"type":"string","format":"date-time","description":"The timestamp for the first click from this referrer."},"last_click":{"type":"string","format":"date-time","description":"The timestamp for the last click from this referrer."},"referrer":{"type":"string","description":"A referrer (truncated to 100 bytes)."}},"description":"A single instance of a campaign referral.","title":"30ReportsCampaignIdEepurlGetResponsesContentApplicationJsonSchemaReferrersItems"},"30ReportsCampaignIdEepurlGetResponsesContentApplicationJsonSchemaTwitterStatusesItems":{"type":"object","properties":{"datetime":{"type":"string","format":"date-time","description":"A timestamp for the tweet."},"is_retweet":{"type":"boolean","description":"A 'true' or 'false' status of whether the tweet is a retweet."},"screen_name":{"type":"string","description":"The Twitter handle for the author of the tweet."},"status":{"type":"string","description":"The body of the tweet."},"status_id":{"type":"string","description":"The individual id for the tweet."}},"description":"An individual tweet.","title":"30ReportsCampaignIdEepurlGetResponsesContentApplicationJsonSchemaTwitterStatusesItems"},"30ReportsCampaignIdEepurlGetResponsesContentApplicationJsonSchemaTwitter":{"type":"object","properties":{"first_tweet":{"type":"string","description":"The day and time of the first recorded tweet with a link to the campaign."},"last_tweet":{"type":"string","description":"The day and time of the last recorded tweet with a link to the campaign."},"retweets":{"type":"integer","description":"The number of retweets that include a link to the campaign."},"statuses":{"type":"array","items":{"$ref":"#/components/schemas/30ReportsCampaignIdEepurlGetResponsesContentApplicationJsonSchemaTwitterStatusesItems"},"description":"A summary of tweets that include a link to the campaign."},"tweets":{"type":"integer","description":"The number of tweets including a link to the campaign."}},"description":"A summary of Twitter activity for a campaign.","title":"30ReportsCampaignIdEepurlGetResponsesContentApplicationJsonSchemaTwitter"},"reports_list-eepurl_Response_200":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/30ReportsCampaignIdEepurlGetResponsesContentApplicationJsonSchemaLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"campaign_id":{"type":"string","description":"The unique id for the campaign."},"clicks":{"$ref":"#/components/schemas/30ReportsCampaignIdEepurlGetResponsesContentApplicationJsonSchemaClicks","description":"A summary of the click-throughs on the campaign's URL."},"eepurl":{"type":"string","description":"The shortened link used for tracking."},"referrers":{"type":"array","items":{"$ref":"#/components/schemas/30ReportsCampaignIdEepurlGetResponsesContentApplicationJsonSchemaReferrersItems"},"description":"A summary of the top referrers for the campaign."},"total_items":{"type":"integer","description":"The total number of items matching the query regardless of pagination."},"twitter":{"$ref":"#/components/schemas/30ReportsCampaignIdEepurlGetResponsesContentApplicationJsonSchemaTwitter","description":"A summary of Twitter activity for a campaign."}},"description":"A summary of social activity for the campaign, tracked by EepURL.","title":"reports_list-eepurl_Response_200"},"30ReportsCampaignIdEmailActivityGetResponsesContentApplicationJsonSchemaLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"30ReportsCampaignIdEmailActivityGetResponsesContentApplicationJsonSchemaLinksItemsMethod"},"30ReportsCampaignIdEmailActivityGetResponsesContentApplicationJsonSchemaLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/30ReportsCampaignIdEmailActivityGetResponsesContentApplicationJsonSchemaLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"30ReportsCampaignIdEmailActivityGetResponsesContentApplicationJsonSchemaLinksItems"},"EmailActivityLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"EmailActivityLinksItemsMethod"},"EmailActivityLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/EmailActivityLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"EmailActivityLinksItems"},"EmailActivityActivityItems":{"type":"object","properties":{"action":{"type":"string","description":"One of the following actions: 'open', 'click', or 'bounce'"},"ip":{"type":"string","description":"The IP address recorded for the action."},"timestamp":{"type":"string","format":"date-time","description":"The date and time recorded for the action in ISO 8601 format."},"type":{"type":"string","description":"If the action is a 'bounce', the type of bounce received: 'hard', 'soft'."},"url":{"type":"string","description":"If the action is a 'click', the URL on which the member clicked."}},"description":"A summary of the interaction with the campaign.","title":"EmailActivityActivityItems"},"EmailActivity":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/EmailActivityLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"activity":{"type":"array","items":{"$ref":"#/components/schemas/EmailActivityActivityItems"},"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."},"campaign_id":{"type":"string","description":"The unique id for the campaign."},"email_address":{"type":"string","description":"Email address for a subscriber."},"email_id":{"type":"string","description":"The MD5 hash of the lowercase version of the list member's email address."},"list_id":{"type":"string","description":"The unique id for the list."},"list_is_active":{"type":"boolean","description":"The status of the list used, namely if it's deleted or disabled."}},"description":"A list of a member's subscriber activity in a specific campaign, including opens, clicks, and bounces.","title":"EmailActivity"},"reports_list-email-activity_Response_200":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/30ReportsCampaignIdEmailActivityGetResponsesContentApplicationJsonSchemaLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"campaign_id":{"type":"string","description":"The unique id for the sent campaign."},"emails":{"type":"array","items":{"$ref":"#/components/schemas/EmailActivity"},"description":"An array of members that were sent the campaign."},"total_items":{"type":"integer","description":"The total number of items matching the query regardless of pagination."}},"description":"A list of member's subscriber activity in a specific campaign.","title":"reports_list-email-activity_Response_200"},"30ReportsCampaignIdLocationsGetResponsesContentApplicationJsonSchemaLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"30ReportsCampaignIdLocationsGetResponsesContentApplicationJsonSchemaLinksItemsMethod"},"30ReportsCampaignIdLocationsGetResponsesContentApplicationJsonSchemaLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/30ReportsCampaignIdLocationsGetResponsesContentApplicationJsonSchemaLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"30ReportsCampaignIdLocationsGetResponsesContentApplicationJsonSchemaLinksItems"},"30ReportsCampaignIdLocationsGetResponsesContentApplicationJsonSchemaLocationsItems":{"type":"object","properties":{"country_code":{"type":"string","description":"The ISO 3166 2 digit country code."},"opens":{"type":"integer","description":"The number of unique campaign opens for a region."},"proxy_excluded_opens":{"type":"integer","description":"The number of unique campaign opens for a region excluding opens from email clients that use proxies."},"region":{"type":"string","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."},"region_name":{"type":"string","description":"The name of the region, if we have one. For blank \"region\" values, this will be \"Rest of Country\"."}},"title":"30ReportsCampaignIdLocationsGetResponsesContentApplicationJsonSchemaLocationsItems"},"reports_list-locations_Response_200":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/30ReportsCampaignIdLocationsGetResponsesContentApplicationJsonSchemaLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"campaign_id":{"type":"string","description":"The campaign id."},"locations":{"type":"array","items":{"$ref":"#/components/schemas/30ReportsCampaignIdLocationsGetResponsesContentApplicationJsonSchemaLocationsItems"},"description":"An array of objects, each representing a top location for opens."},"total_items":{"type":"integer","description":"The total number of items matching the query regardless of pagination."}},"description":"Top open locations for a specific campaign.","title":"reports_list-locations_Response_200"},"30ReportsCampaignIdOpenDetailsGetParametersSortField":{"type":"string","enum":["opens_count"],"title":"30ReportsCampaignIdOpenDetailsGetParametersSortField"},"30ReportsCampaignIdOpenDetailsGetParametersSortDir":{"type":"string","enum":["ASC","DESC"],"title":"30ReportsCampaignIdOpenDetailsGetParametersSortDir"},"30ReportsCampaignIdOpenDetailsGetResponsesContentApplicationJsonSchemaLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"30ReportsCampaignIdOpenDetailsGetResponsesContentApplicationJsonSchemaLinksItemsMethod"},"30ReportsCampaignIdOpenDetailsGetResponsesContentApplicationJsonSchemaLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/30ReportsCampaignIdOpenDetailsGetResponsesContentApplicationJsonSchemaLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"30ReportsCampaignIdOpenDetailsGetResponsesContentApplicationJsonSchemaLinksItems"},"OpenActivityLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"OpenActivityLinksItemsMethod"},"OpenActivityLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/OpenActivityLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"OpenActivityLinksItems"},"OpenActivityMergeFields0":{"type":"object","properties":{"addr1":{"type":"string"},"addr2":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"zip":{"type":"string"},"country":{"type":"string"}},"required":["addr1","city","state","zip"],"title":"OpenActivityMergeFields0"},"OpenActivityMergeFields":{"oneOf":[{"$ref":"#/components/schemas/OpenActivityMergeFields0"},{"type":"string"},{"type":"number","format":"double"}],"description":"This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field.","title":"OpenActivityMergeFields"},"OpenActivityOpensItems":{"type":"object","properties":{"is_proxy_open":{"type":"boolean","description":"Indicates if the open was from an email client that use proxies."},"timestamp":{"type":"string","format":"date-time","description":"The date and time recorded for the action in ISO 8601 format."}},"description":"A summary of the interaction with the campaign.","title":"OpenActivityOpensItems"},"OpenActivity":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/OpenActivityLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"campaign_id":{"type":"string","description":"The unique id for the campaign."},"contact_status":{"type":"string","description":"The status of the member, namely if they are subscribed, unsubscribed, deleted, non-subscribed, transactional, pending, or need reconfirmation."},"email_address":{"type":"string","description":"Email address for a subscriber."},"email_id":{"type":"string","description":"The MD5 hash of the lowercase version of the list member's email address."},"list_id":{"type":"string","description":"The unique id for the list."},"list_is_active":{"type":"boolean","description":"The status of the list used, namely if it's deleted or disabled."},"merge_fields":{"type":["object","null"],"additionalProperties":{"$ref":"#/components/schemas/OpenActivityMergeFields"},"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."},"opens":{"type":"array","items":{"$ref":"#/components/schemas/OpenActivityOpensItems"},"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."},"opens_count":{"type":"integer","description":"The total number of times the this campaign was opened by the list member."},"proxy_excluded_opens_count":{"type":"integer","description":"The total number of times the this campaign was opened by the list member excluding opens from email clients that use proxies ."},"vip":{"type":"boolean","description":"[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber."}},"description":"A list of a member's opens activity in a specific campaign.","title":"OpenActivity"},"reports_list-open-details_Response_200":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/30ReportsCampaignIdOpenDetailsGetResponsesContentApplicationJsonSchemaLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"campaign_id":{"type":"string","description":"The campaign id."},"members":{"type":"array","items":{"$ref":"#/components/schemas/OpenActivity"},"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."},"total_items":{"type":"integer","description":"The total number of items matching the query regardless of pagination."},"total_opens":{"type":"integer","description":"The total number of opens matching the query regardless of pagination."},"total_proxy_excluded_opens":{"type":"integer","description":"The total number of opens excluding opens from email clients that use proxies regardless of pagination."}},"description":"A detailed report of any campaign emails that were opened by a list member.","title":"reports_list-open-details_Response_200"},"30ReportsCampaignIdSentToGetResponsesContentApplicationJsonSchemaLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"30ReportsCampaignIdSentToGetResponsesContentApplicationJsonSchemaLinksItemsMethod"},"30ReportsCampaignIdSentToGetResponsesContentApplicationJsonSchemaLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/30ReportsCampaignIdSentToGetResponsesContentApplicationJsonSchemaLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"30ReportsCampaignIdSentToGetResponsesContentApplicationJsonSchemaLinksItems"},"SentToLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"SentToLinksItemsMethod"},"SentToLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/SentToLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"SentToLinksItems"},"SentToAbsplitGroup":{"type":"string","enum":["a","b","winner"],"description":"For A/B Split Campaigns, the group the member was apart of.","title":"SentToAbsplitGroup"},"SentToMergeFields0":{"type":"object","properties":{"addr1":{"type":"string"},"addr2":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"zip":{"type":"string"},"country":{"type":"string"}},"required":["addr1","city","state","zip"],"title":"SentToMergeFields0"},"SentToMergeFields":{"oneOf":[{"$ref":"#/components/schemas/SentToMergeFields0"},{"type":"string"},{"type":"number","format":"double"}],"description":"This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field.","title":"SentToMergeFields"},"SentToStatus":{"type":"string","enum":["sent","hard","soft"],"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/).","title":"SentToStatus"},"SentTo":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/SentToLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"absplit_group":{"$ref":"#/components/schemas/SentToAbsplitGroup","description":"For A/B Split Campaigns, the group the member was apart of."},"campaign_id":{"type":"string","description":"The campaign id."},"email_address":{"type":"string","description":"Email address for a subscriber."},"email_id":{"type":"string","description":"The MD5 hash of the lowercase version of the list member's email address."},"gmt_offset":{"type":"integer","description":"For campaigns sent with timewarp, the time zone group the member is apart of."},"last_open":{"type":"string","format":"date-time","description":"The date and time of the last open for this member in ISO 8601 format."},"list_id":{"type":"string","description":"The unique list id."},"list_is_active":{"type":"boolean","description":"The status of the list used, namely if it's deleted or disabled."},"merge_fields":{"type":["object","null"],"additionalProperties":{"$ref":"#/components/schemas/SentToMergeFields"},"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."},"open_count":{"type":"integer","description":"The number of times a campaign was opened by this member."},"status":{"$ref":"#/components/schemas/SentToStatus","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/)."},"vip":{"type":"boolean","description":"[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber."}},"description":"A subscriber's status for a specific campaign.","title":"SentTo"},"reports_list-sent-to_Response_200":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/30ReportsCampaignIdSentToGetResponsesContentApplicationJsonSchemaLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"campaign_id":{"type":"string","description":"The campaign id."},"sent_to":{"type":"array","items":{"$ref":"#/components/schemas/SentTo"},"description":"An array of objects, each representing a campaign recipient."},"total_items":{"type":"integer","description":"The total number of items matching the query regardless of pagination."}},"description":"A list of subscribers who were sent a specific campaign.","title":"reports_list-sent-to_Response_200"},"30ReportsCampaignIdSubReportsGetResponsesContentApplicationJsonSchemaLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"30ReportsCampaignIdSubReportsGetResponsesContentApplicationJsonSchemaLinksItemsMethod"},"30ReportsCampaignIdSubReportsGetResponsesContentApplicationJsonSchemaLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/30ReportsCampaignIdSubReportsGetResponsesContentApplicationJsonSchemaLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"30ReportsCampaignIdSubReportsGetResponsesContentApplicationJsonSchemaLinksItems"},"reports_list-sub-reports_Response_200":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/30ReportsCampaignIdSubReportsGetResponsesContentApplicationJsonSchemaLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"campaign_id":{"type":"string","description":"Unique identifier of the parent campaign"},"reports":{"type":"array","items":{"$ref":"#/components/schemas/CampaignReport"},"description":"An array of objects, each representing a report resource."},"total_items":{"type":"integer","description":"The total number of items matching the query regardless of pagination."}},"description":"A list of reports containing child campaigns for a specific campaign.","title":"reports_list-sub-reports_Response_200"},"30ReportsCampaignIdUnsubscribedGetResponsesContentApplicationJsonSchemaLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"30ReportsCampaignIdUnsubscribedGetResponsesContentApplicationJsonSchemaLinksItemsMethod"},"30ReportsCampaignIdUnsubscribedGetResponsesContentApplicationJsonSchemaLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/30ReportsCampaignIdUnsubscribedGetResponsesContentApplicationJsonSchemaLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"30ReportsCampaignIdUnsubscribedGetResponsesContentApplicationJsonSchemaLinksItems"},"UnsubscribesLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"UnsubscribesLinksItemsMethod"},"UnsubscribesLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/UnsubscribesLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"UnsubscribesLinksItems"},"UnsubscribesMergeFields0":{"type":"object","properties":{"addr1":{"type":"string"},"addr2":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"zip":{"type":"string"},"country":{"type":"string"}},"required":["addr1","city","state","zip"],"title":"UnsubscribesMergeFields0"},"UnsubscribesMergeFields":{"oneOf":[{"$ref":"#/components/schemas/UnsubscribesMergeFields0"},{"type":"string"},{"type":"number","format":"double"}],"description":"This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field.","title":"UnsubscribesMergeFields"},"Unsubscribes":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/UnsubscribesLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"campaign_id":{"type":"string","description":"The campaign id."},"email_address":{"type":"string","description":"Email address for a subscriber."},"email_id":{"type":"string","description":"The MD5 hash of the lowercase version of the list member's email address."},"list_id":{"type":"string","description":"The list id."},"list_is_active":{"type":"boolean","description":"The status of the list used, namely if it's deleted or disabled."},"merge_fields":{"type":["object","null"],"additionalProperties":{"$ref":"#/components/schemas/UnsubscribesMergeFields"},"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."},"reason":{"type":"string","description":"If available, the reason listed by the member for unsubscribing."},"timestamp":{"type":"string","format":"date-time","description":"The date and time the member opted-out in ISO 8601 format."},"vip":{"type":"boolean","description":"[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber."}},"description":"A member who unsubscribed from a specific campaign.","title":"Unsubscribes"},"reports_list-unsubscribed_Response_200":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/30ReportsCampaignIdUnsubscribedGetResponsesContentApplicationJsonSchemaLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"campaign_id":{"type":"string","description":"The campaign id."},"total_items":{"type":"integer","description":"The total number of items matching the query regardless of pagination."},"unsubscribes":{"type":"array","items":{"$ref":"#/components/schemas/Unsubscribes"},"description":"An array of objects, each representing a member who unsubscribed from a campaign."}},"description":"A list of members who have unsubscribed from a specific campaign.","title":"reports_list-unsubscribed_Response_200"},"30SearchCampaignsGetResponsesContentApplicationJsonSchemaLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"30SearchCampaignsGetResponsesContentApplicationJsonSchemaLinksItemsMethod"},"30SearchCampaignsGetResponsesContentApplicationJsonSchemaLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/30SearchCampaignsGetResponsesContentApplicationJsonSchemaLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"30SearchCampaignsGetResponsesContentApplicationJsonSchemaLinksItems"},"30SearchCampaignsGetResponsesContentApplicationJsonSchemaResultsItems":{"type":"object","properties":{"campaign":{"$ref":"#/components/schemas/Campaigns"},"snippet":{"type":"string"}},"title":"30SearchCampaignsGetResponsesContentApplicationJsonSchemaResultsItems"},"search-campaigns_list_Response_200":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/30SearchCampaignsGetResponsesContentApplicationJsonSchemaLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"results":{"type":"array","items":{"$ref":"#/components/schemas/30SearchCampaignsGetResponsesContentApplicationJsonSchemaResultsItems"},"description":"An array of matching campaigns and snippets."},"total_items":{"type":"integer","description":"The total number of items matching the query regardless of pagination."}},"description":"Campaigns and Snippets found for given search term.","title":"search-campaigns_list_Response_200"},"SmsCampaignLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"SmsCampaignLinksItemsMethod"},"SmsCampaignLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/SmsCampaignLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"SmsCampaignLinksItems"},"SmsCampaign":{"type":"object","properties":{"id":{"type":"string","description":"A string that uniquely identifies this campaign."},"web_id":{"type":"string","description":"The ID used in the Mailchimp web application."},"name":{"type":"string","description":"The name of the campaign."},"status":{"type":"string","description":"The current status of the campaign."},"channel":{"type":"string","description":"The channel for this campaign (sms or whatsapp)."},"list_id":{"type":"integer","description":"The numeric ID of the list associated with this campaign."},"recipient_count":{"type":"integer","description":"The number of recipients for this campaign."},"create_time":{"type":"string","format":"date-time","description":"The date and time the campaign was created."},"send_time":{"type":"string","format":"date-time","description":"The date and time the campaign is scheduled to send."},"updated_at":{"type":"string","format":"date-time","description":"The date and time the campaign was last updated."},"expire_time":{"type":"string","format":"date-time","description":"The date and time the campaign will stop sending in ISO 8601 format."},"is_send_now":{"type":"boolean","description":"Whether the campaign is configured to send immediately."},"folder_id":{"type":"string","description":"The ID of the folder this campaign is in."},"segments":{"type":"array","items":{"type":"integer"},"description":"The segment IDs used to target recipients for this campaign."},"excluded_segments":{"type":"array","items":{"type":"integer"},"description":"The segment IDs excluded from receiving this campaign."},"_links":{"type":"array","items":{"$ref":"#/components/schemas/SmsCampaignLinksItems"},"description":"A list of link types and descriptions for the API schema documents."}},"description":"A single SMS campaign.","title":"SmsCampaign"},"30SmsCampaignsGetResponsesContentApplicationJsonSchemaLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"30SmsCampaignsGetResponsesContentApplicationJsonSchemaLinksItemsMethod"},"30SmsCampaignsGetResponsesContentApplicationJsonSchemaLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/30SmsCampaignsGetResponsesContentApplicationJsonSchemaLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"30SmsCampaignsGetResponsesContentApplicationJsonSchemaLinksItems"},"sms-campaigns_list_Response_200":{"type":"object","properties":{"sms_campaigns":{"type":"array","items":{"$ref":"#/components/schemas/SmsCampaign"},"description":"An array of SMS campaigns."},"total_items":{"type":"integer","description":"The total number of items matching the query regardless of pagination."},"_links":{"type":"array","items":{"$ref":"#/components/schemas/30SmsCampaignsGetResponsesContentApplicationJsonSchemaLinksItems"},"description":"A list of link types and descriptions for the API schema documents."}},"description":"A collection of SMS campaigns.","title":"sms-campaigns_list_Response_200"},"SmsCampaignContent":{"type":"object","properties":{"content_type":{"type":"string","description":"The content type of the message."},"sender":{"type":"string","description":"The sender identifier for the message."},"optout_message_language":{"type":"string","description":"The language of the opt-out message."}},"description":"Additional content properties.","title":"SmsCampaignContent"},"30SmsCampaignsSmsCampaignIdContentPutRequestBodyContentApplicationJsonSchemaMediaItems":{"type":"object","properties":{"url":{"type":"string","description":"The URL of the media file."}},"title":"30SmsCampaignsSmsCampaignIdContentPutRequestBodyContentApplicationJsonSchemaMediaItems"},"30SearchMembersGetResponsesContentApplicationJsonSchemaLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"30SearchMembersGetResponsesContentApplicationJsonSchemaLinksItemsMethod"},"30SearchMembersGetResponsesContentApplicationJsonSchemaLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/30SearchMembersGetResponsesContentApplicationJsonSchemaLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"30SearchMembersGetResponsesContentApplicationJsonSchemaLinksItems"},"30SearchMembersGetResponsesContentApplicationJsonSchemaExactMatches":{"type":"object","properties":{"members":{"type":"array","items":{"$ref":"#/components/schemas/ListMembers"},"description":"An array of objects, each representing a specific list member."},"total_items":{"type":"integer","description":"The total number of items matching the query regardless of pagination."}},"description":"Exact matches of the provided search query.","title":"30SearchMembersGetResponsesContentApplicationJsonSchemaExactMatches"},"30SearchMembersGetResponsesContentApplicationJsonSchemaFullSearch":{"type":"object","properties":{"members":{"type":"array","items":{"$ref":"#/components/schemas/ListMembers"},"description":"An array of objects, each representing a specific list member."},"total_items":{"type":"integer","description":"The total number of items matching the query regardless of pagination."}},"description":"Partial matches of the provided search query.","title":"30SearchMembersGetResponsesContentApplicationJsonSchemaFullSearch"},"search-members_list_Response_200":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/30SearchMembersGetResponsesContentApplicationJsonSchemaLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"exact_matches":{"$ref":"#/components/schemas/30SearchMembersGetResponsesContentApplicationJsonSchemaExactMatches","description":"Exact matches of the provided search query."},"full_search":{"$ref":"#/components/schemas/30SearchMembersGetResponsesContentApplicationJsonSchemaFullSearch","description":"Partial matches of the provided search query."}},"description":"Members found for given search term","title":"search-members_list_Response_200"},"30TemplateFoldersGetResponsesContentApplicationJsonSchemaLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"30TemplateFoldersGetResponsesContentApplicationJsonSchemaLinksItemsMethod"},"30TemplateFoldersGetResponsesContentApplicationJsonSchemaLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/30TemplateFoldersGetResponsesContentApplicationJsonSchemaLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"30TemplateFoldersGetResponsesContentApplicationJsonSchemaLinksItems"},"30TemplateFoldersGetResponsesContentApplicationJsonSchemaFoldersItemsLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"30TemplateFoldersGetResponsesContentApplicationJsonSchemaFoldersItemsLinksItemsMethod"},"30TemplateFoldersGetResponsesContentApplicationJsonSchemaFoldersItemsLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/30TemplateFoldersGetResponsesContentApplicationJsonSchemaFoldersItemsLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"30TemplateFoldersGetResponsesContentApplicationJsonSchemaFoldersItemsLinksItems"},"30TemplateFoldersGetResponsesContentApplicationJsonSchemaFoldersItems":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/30TemplateFoldersGetResponsesContentApplicationJsonSchemaFoldersItemsLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"count":{"type":"integer","description":"The number of templates in the folder."},"id":{"type":"string","description":"A string that uniquely identifies this template folder."},"name":{"type":"string","description":"The name of the folder."}},"description":"A folder used to organize templates.","title":"30TemplateFoldersGetResponsesContentApplicationJsonSchemaFoldersItems"},"template-folders_list_Response_200":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/30TemplateFoldersGetResponsesContentApplicationJsonSchemaLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"folders":{"type":"array","items":{"$ref":"#/components/schemas/30TemplateFoldersGetResponsesContentApplicationJsonSchemaFoldersItems"},"description":"An array of objects representing template folders."},"total_items":{"type":"integer","description":"The total number of items matching the query regardless of pagination."}},"description":"A list of template folders","title":"template-folders_list_Response_200"},"30TemplateFoldersPostResponsesContentApplicationJsonSchemaLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"30TemplateFoldersPostResponsesContentApplicationJsonSchemaLinksItemsMethod"},"30TemplateFoldersPostResponsesContentApplicationJsonSchemaLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/30TemplateFoldersPostResponsesContentApplicationJsonSchemaLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"30TemplateFoldersPostResponsesContentApplicationJsonSchemaLinksItems"},"template-folders_create_Response_200":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/30TemplateFoldersPostResponsesContentApplicationJsonSchemaLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"count":{"type":"integer","description":"The number of templates in the folder."},"id":{"type":"string","description":"A string that uniquely identifies this template folder."},"name":{"type":"string","description":"The name of the folder."}},"description":"A folder used to organize templates.","title":"template-folders_create_Response_200"},"30TemplateFoldersFolderIdGetResponsesContentApplicationJsonSchemaLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"30TemplateFoldersFolderIdGetResponsesContentApplicationJsonSchemaLinksItemsMethod"},"30TemplateFoldersFolderIdGetResponsesContentApplicationJsonSchemaLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/30TemplateFoldersFolderIdGetResponsesContentApplicationJsonSchemaLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"30TemplateFoldersFolderIdGetResponsesContentApplicationJsonSchemaLinksItems"},"template-folders_get_Response_200":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/30TemplateFoldersFolderIdGetResponsesContentApplicationJsonSchemaLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"count":{"type":"integer","description":"The number of templates in the folder."},"id":{"type":"string","description":"A string that uniquely identifies this template folder."},"name":{"type":"string","description":"The name of the folder."}},"description":"A folder used to organize templates.","title":"template-folders_get_Response_200"},"30TemplateFoldersFolderIdPatchResponsesContentApplicationJsonSchemaLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"30TemplateFoldersFolderIdPatchResponsesContentApplicationJsonSchemaLinksItemsMethod"},"30TemplateFoldersFolderIdPatchResponsesContentApplicationJsonSchemaLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/30TemplateFoldersFolderIdPatchResponsesContentApplicationJsonSchemaLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"30TemplateFoldersFolderIdPatchResponsesContentApplicationJsonSchemaLinksItems"},"template-folders_update_Response_200":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/30TemplateFoldersFolderIdPatchResponsesContentApplicationJsonSchemaLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"count":{"type":"integer","description":"The number of templates in the folder."},"id":{"type":"string","description":"A string that uniquely identifies this template folder."},"name":{"type":"string","description":"The name of the folder."}},"description":"A folder used to organize templates.","title":"template-folders_update_Response_200"},"30TemplatesGetParametersSortField":{"type":"string","enum":["date_created","date_edited","name"],"title":"30TemplatesGetParametersSortField"},"30TemplatesGetParametersContentType":{"type":"string","enum":["html","template","multichannel"],"title":"30TemplatesGetParametersContentType"},"30TemplatesGetParametersSortDir":{"type":"string","enum":["ASC","DESC"],"title":"30TemplatesGetParametersSortDir"},"30TemplatesGetResponsesContentApplicationJsonSchemaLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"30TemplatesGetResponsesContentApplicationJsonSchemaLinksItemsMethod"},"30TemplatesGetResponsesContentApplicationJsonSchemaLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/30TemplatesGetResponsesContentApplicationJsonSchemaLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"30TemplatesGetResponsesContentApplicationJsonSchemaLinksItems"},"TemplateInstanceLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"TemplateInstanceLinksItemsMethod"},"TemplateInstanceLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/TemplateInstanceLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"TemplateInstanceLinksItems"},"TemplateInstanceContentType":{"type":"string","enum":["template","multichannel","html"],"description":"How the template's content is put together.","title":"TemplateInstanceContentType"},"TemplateInstance":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/TemplateInstanceLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"active":{"type":"boolean","description":"User templates are not 'deleted,' but rather marked as 'inactive.' Returns whether the template is still active."},"category":{"type":"string","description":"If available, the category the template is listed in."},"content_type":{"$ref":"#/components/schemas/TemplateInstanceContentType","description":"How the template's content is put together."},"created_by":{"type":"string","description":"The login name for template's creator."},"date_created":{"type":"string","format":"date-time","description":"The date and time the template was created in ISO 8601 format."},"date_edited":{"type":"string","format":"date-time","description":"The date and time the template was edited in ISO 8601 format."},"drag_and_drop":{"type":"boolean","description":"Whether the template uses the drag and drop editor."},"edited_by":{"type":"string","description":"The login name who last edited the template."},"folder_id":{"type":"string","description":"The id of the folder the template is currently in."},"id":{"type":"integer","description":"The individual id for the template."},"name":{"type":"string","description":"The name of the template."},"responsive":{"type":"boolean","description":"Whether the template contains media queries to make it responsive."},"share_url":{"type":"string","description":"The URL used for [template sharing](https://mailchimp.com/help/share-a-template/)."},"thumbnail":{"type":"string","description":"If available, the URL for a thumbnail of the template."},"type":{"type":"string","description":"The type of template (user, base, or gallery)."}},"description":"Information about a specific template.","title":"TemplateInstance"},"templates_list_Response_200":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/30TemplatesGetResponsesContentApplicationJsonSchemaLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"templates":{"type":"array","items":{"$ref":"#/components/schemas/TemplateInstance"},"description":"All of an account's saved or custom templates."},"total_items":{"type":"integer","description":"The total number of items matching the query regardless of pagination."}},"description":"A list an account's available templates.","title":"templates_list_Response_200"},"30TemplatesPostRequestBodyContentApplicationJsonSchemaHtml":{"oneOf":[{"type":"string"}],"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":"30TemplatesPostRequestBodyContentApplicationJsonSchemaHtml"},"30TemplatesTemplateIdDefaultContentGetResponsesContentApplicationJsonSchemaLinksItemsMethod":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"description":"The HTTP method that should be used when accessing the URL defined in 'href'.","title":"30TemplatesTemplateIdDefaultContentGetResponsesContentApplicationJsonSchemaLinksItemsMethod"},"30TemplatesTemplateIdDefaultContentGetResponsesContentApplicationJsonSchemaLinksItems":{"type":"object","properties":{"href":{"type":"string","description":"This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."},"method":{"$ref":"#/components/schemas/30TemplatesTemplateIdDefaultContentGetResponsesContentApplicationJsonSchemaLinksItemsMethod","description":"The HTTP method that should be used when accessing the URL defined in 'href'."},"rel":{"type":"string","description":"As with an HTML 'rel' attribute, this describes the type of link."},"schema":{"type":"string","description":"For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."},"targetSchema":{"type":"string","description":"For GETs, this is a URL representing the schema that the response should conform to."}},"description":"This object represents a link from the resource where it is found to another resource or action that may be performed.","title":"30TemplatesTemplateIdDefaultContentGetResponsesContentApplicationJsonSchemaLinksItems"},"templates_list-default-content_Response_200":{"type":"object","properties":{"_links":{"type":"array","items":{"$ref":"#/components/schemas/30TemplatesTemplateIdDefaultContentGetResponsesContentApplicationJsonSchemaLinksItems"},"description":"A list of link types and descriptions for the API schema documents."},"sections":{"type":"object","additionalProperties":{"description":"Any type"},"description":"The sections that you can edit in the template, including each section's default content."}},"description":"Default content for a template.","title":"templates_list-default-content_Response_200"},"30VerifiedDomainsGetResponsesContentApplicationJsonSchemaDomainsItemsStatus":{"type":"string","enum":["VERIFICATION_IN_PROGRESS","VERIFIED","EXPIRED","ERROR","AUTHENTICATION_IN_PROGRESS","AUTHENTICATION_ERROR","AUTHENTICATED"],"description":"The Domain's current status.","title":"30VerifiedDomainsGetResponsesContentApplicationJsonSchemaDomainsItemsStatus"},"30VerifiedDomainsGetResponsesContentApplicationJsonSchemaDomainsItems":{"type":"object","properties":{"authenticated":{"type":"boolean","description":"Whether domain authentication is enabled for this domain."},"domain":{"type":"string","description":"The name of this domain."},"is_free_email_provider":{"type":"boolean","description":"Returns whether the domain used is a public / free email provider. See [Limitations of Free Email Addresses](https://mailchimp.com/help/limitations-of-free-email-addresses/) for more details."},"status":{"$ref":"#/components/schemas/30VerifiedDomainsGetResponsesContentApplicationJsonSchemaDomainsItemsStatus","description":"The Domain's current status."},"verification_email":{"type":"string","description":"The e-mail address receiving the two-factor challenge for this domain."},"verification_sent":{"type":"string","format":"date-time","description":"The date/time that the two-factor challenge was sent to the verification email."},"verified":{"type":"boolean","description":"Whether the domain has been verified for sending."}},"description":"The verified domains currently on the account.","title":"30VerifiedDomainsGetResponsesContentApplicationJsonSchemaDomainsItems"},"verified-domains_list_Response_200":{"type":"object","properties":{"domains":{"type":"array","items":{"$ref":"#/components/schemas/30VerifiedDomainsGetResponsesContentApplicationJsonSchemaDomainsItems"},"description":"The domains on the account"},"total_items":{"type":"integer","description":"The total number of items matching the query regardless of pagination."}},"description":"The verified domains currently on the account.","title":"verified-domains_list_Response_200"},"30VerifiedDomainsPostResponsesContentApplicationJsonSchemaStatus":{"type":"string","enum":["VERIFICATION_IN_PROGRESS","VERIFIED","EXPIRED","ERROR","AUTHENTICATION_IN_PROGRESS","AUTHENTICATION_ERROR","AUTHENTICATED"],"description":"The Domain's current status.","title":"30VerifiedDomainsPostResponsesContentApplicationJsonSchemaStatus"},"verified-domains_create_Response_200":{"type":"object","properties":{"authenticated":{"type":"boolean","description":"Whether domain authentication is enabled for this domain."},"domain":{"type":"string","description":"The name of this domain."},"is_free_email_provider":{"type":"boolean","description":"Returns whether the domain used is a public / free email provider. See [Limitations of Free Email Addresses](https://mailchimp.com/help/limitations-of-free-email-addresses/) for more details."},"status":{"$ref":"#/components/schemas/30VerifiedDomainsPostResponsesContentApplicationJsonSchemaStatus","description":"The Domain's current status."},"verification_email":{"type":"string","description":"The e-mail address receiving the two-factor challenge for this domain."},"verification_sent":{"type":"string","format":"date-time","description":"The date/time that the two-factor challenge was sent to the verification email."},"verified":{"type":"boolean","description":"Whether the domain has been verified for sending."}},"description":"The verified domains currently on the account.","title":"verified-domains_create_Response_200"},"30VerifiedDomainsDomainNameGetResponsesContentApplicationJsonSchemaStatus":{"type":"string","enum":["VERIFICATION_IN_PROGRESS","VERIFIED","EXPIRED","ERROR","AUTHENTICATION_IN_PROGRESS","AUTHENTICATION_ERROR","AUTHENTICATED"],"description":"The Domain's current status.","title":"30VerifiedDomainsDomainNameGetResponsesContentApplicationJsonSchemaStatus"},"verified-domains_get_Response_200":{"type":"object","properties":{"authenticated":{"type":"boolean","description":"Whether domain authentication is enabled for this domain."},"domain":{"type":"string","description":"The name of this domain."},"is_free_email_provider":{"type":"boolean","description":"Returns whether the domain used is a public / free email provider. See [Limitations of Free Email Addresses](https://mailchimp.com/help/limitations-of-free-email-addresses/) for more details."},"status":{"$ref":"#/components/schemas/30VerifiedDomainsDomainNameGetResponsesContentApplicationJsonSchemaStatus","description":"The Domain's current status."},"verification_email":{"type":"string","description":"The e-mail address receiving the two-factor challenge for this domain."},"verification_sent":{"type":"string","format":"date-time","description":"The date/time that the two-factor challenge was sent to the verification email."},"verified":{"type":"boolean","description":"Whether the domain has been verified for sending."}},"description":"The verified domains currently on the account.","title":"verified-domains_get_Response_200"},"30VerifiedDomainsDomainNameActionsVerifyPostResponsesContentApplicationJsonSchemaStatus":{"type":"string","enum":["VERIFICATION_IN_PROGRESS","VERIFIED","EXPIRED","ERROR","AUTHENTICATION_IN_PROGRESS","AUTHENTICATION_ERROR","AUTHENTICATED"],"description":"The Domain's current status.","title":"30VerifiedDomainsDomainNameActionsVerifyPostResponsesContentApplicationJsonSchemaStatus"},"verified-domains_create-action-verify_Response_200":{"type":"object","properties":{"authenticated":{"type":"boolean","description":"Whether domain authentication is enabled for this domain."},"domain":{"type":"string","description":"The name of this domain."},"is_free_email_provider":{"type":"boolean","description":"Returns whether the domain used is a public / free email provider. See [Limitations of Free Email Addresses](https://mailchimp.com/help/limitations-of-free-email-addresses/) for more details."},"status":{"$ref":"#/components/schemas/30VerifiedDomainsDomainNameActionsVerifyPostResponsesContentApplicationJsonSchemaStatus","description":"The Domain's current status."},"verification_email":{"type":"string","description":"The e-mail address receiving the two-factor challenge for this domain."},"verification_sent":{"type":"string","format":"date-time","description":"The date/time that the two-factor challenge was sent to the verification email."},"verified":{"type":"boolean","description":"Whether the domain has been verified for sending."}},"description":"The verified domains currently on the account.","title":"verified-domains_create-action-verify_Response_200"}},"securitySchemes":{"bearerToken":{"type":"http","scheme":"bearer","description":"Authorization using a Mailchimp API key (a.k.a. Bearer token)"},"oauth2":{"type":"http","scheme":"bearer","description":"Authorization using OAuth"}}}}