@lap v0.3
# Machine-readable API spec. Each @endpoint block is one API call.
@api Mailchimp Marketing API
@base https://server.api.mailchimp.com/3.0
@version 3.0.91
@auth basic
@endpoints 282
@hint download_for_search
@toc root(1), activity-feed(1), account-exports(3), audiences(8), authorized-apps(2), automations(18), batches(4), batch-webhooks(5), template-folders(5), campaign-folders(5), campaigns(22), connected-sites(5), conversations(4), customer-journeys(1), file-manager(11), lists(69), landing-pages(8), reports(22), templates(6), ecommerce(60), search-campaigns(1), search-members(1), ping(1), facebook-ads(2), reporting(12), verified-domains(5)

@group root
@endpoint GET /
@desc List api root resources
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.}
@returns(200)

@endgroup

@group activity-feed
@endpoint GET /activity-feed/chimp-chatter
@desc Get latest chimp chatter
@optional {count: any # The number of records to return. Default value is 10. Maximum value is 1000, offset: any # 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.}
@returns(200) ChimpChatter Collection

@endgroup

@group account-exports
@endpoint GET /account-exports
@desc List account exports
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation., count: any # The number of records to return. Default value is 10. Maximum value is 1000, offset: any # 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.}
@returns(200)

@endpoint POST /account-exports
@desc Add export
@required {body: map}
@returns(200)

@endpoint GET /account-exports/{export_id}
@desc Get account export info
@required {export_id: any # The unique id for the account export.}
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.}
@returns(200)

@endgroup

@group audiences
@endpoint GET /audiences
@desc Get a list of audiences
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation., count: any # The number of records to return. Default value is 10. Maximum value is 1000, offset: any # 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.}
@returns(200)

@endpoint GET /audiences/{audience_id}
@desc Get audience info
@required {audience_id: any # The unique ID for the audience.}
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.}
@returns(200)

@endpoint GET /audiences/{audience_id}/contacts
@desc Get Contacts
@required {audience_id: any # The unique ID for the audience.}
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation., count: any # The number of records to return. Default value is 10. Maximum value is 1000, cursor: any # 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., created_before: any # Restricts the response to contacts created at or before the specified time (inclusive). Uses ISO 8601 format: 2025-04-23T15:41:36+00:00., created_since: any # Restricts the response to contacts created after the specified time (exclusive). Uses ISO 8601 format: 2025-04-23T15:41:36+00:00., updated_before: any # Restricts the response to contacts updated at or before the specified time (inclusive). Uses ISO 8601 format: 2025-04-23T15:41:36+00:00., updated_since: any # Restricts the response to contacts updated after the specified time (exclusive). Uses ISO 8601 format: 2025-04-23T15:41:36+00:00., sort_field: any # Specifies the field to sort the returned contacts by., sort_dir: any # Determines the order direction for sorted results.}
@returns(200)

@endpoint POST /audiences/{audience_id}/contacts
@desc Add Contact
@required {body: map, audience_id: any # The unique ID for the audience.}
@optional {merge_field_validation_mode: any # 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., data_mode: any # 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.}
@returns(200)

@endpoint GET /audiences/{audience_id}/contacts/{contact_id}
@desc Get Contact
@required {audience_id: any # The unique ID for the audience., contact_id: any # 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).}
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.}
@returns(200)

@endpoint PATCH /audiences/{audience_id}/contacts/{contact_id}
@desc Update Contact
@required {body: map, audience_id: any # The unique ID for the audience., contact_id: any # The unique id for the contact.}
@optional {merge_field_validation_mode: any # 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., data_mode: any # 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.}
@returns(200)

@endpoint POST /audiences/{audience_id}/contacts/{contact_id}/actions/archive
@desc Archive Contact
@required {audience_id: any # The unique ID for the audience., contact_id: any # The unique id for the contact.}
@returns(204) Empty Response

@endpoint POST /audiences/{audience_id}/contacts/{contact_id}/actions/forget
@desc Forget Contact
@required {audience_id: any # The unique ID for the audience., contact_id: any # The unique id for the contact.}
@returns(204) Empty Response

@endgroup

@group authorized-apps
@endpoint GET /authorized-apps
@desc List authorized apps
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation., count: any # The number of records to return. Default value is 10. Maximum value is 1000, offset: any # 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.}
@returns(200)

@endpoint GET /authorized-apps/{app_id}
@desc Get authorized app info
@required {app_id: any # The unique id for the connected authorized application.}
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.}
@returns(200)

@endgroup

@group automations
@endpoint GET /automations
@desc List automations
@optional {count: any # The number of records to return. Default value is 10. Maximum value is 1000, offset: any # 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., fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation., before_create_time: any # Restrict the response to automations created before this time. Uses the ISO 8601 time format: 2015-10-21T15:41:36+00:00., since_create_time: any # Restrict the response to automations created after this time. Uses the ISO 8601 time format: 2015-10-21T15:41:36+00:00., before_start_time: any # Restrict the response to automations started before this time. Uses the ISO 8601 time format: 2015-10-21T15:41:36+00:00., since_start_time: any # Restrict the response to automations started after this time. Uses the ISO 8601 time format: 2015-10-21T15:41:36+00:00., status: any # Restrict the results to automations with the specified status.}
@returns(200)

@endpoint POST /automations
@desc Add automation
@required {body: map}
@returns(200)

@endpoint GET /automations/{workflow_id}
@desc Get automation info
@required {workflow_id: any # The unique id for the Automation workflow.}
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.}
@returns(200)

@endpoint POST /automations/{workflow_id}/actions/pause-all-emails
@desc Pause automation emails
@required {workflow_id: any # The unique id for the Automation workflow.}
@returns(204) Empty Response

@endpoint POST /automations/{workflow_id}/actions/start-all-emails
@desc Start automation emails
@required {workflow_id: any # The unique id for the Automation workflow.}
@returns(204) Empty Response

@endpoint POST /automations/{workflow_id}/actions/archive
@desc Archive automation
@required {workflow_id: any # The unique id for the Automation workflow.}
@returns(204) Empty Response

@endpoint GET /automations/{workflow_id}/emails
@desc List automated emails
@required {workflow_id: any # The unique id for the Automation workflow.}
@returns(200)

@endpoint GET /automations/{workflow_id}/emails/{workflow_email_id}
@desc Get workflow email info
@required {workflow_id: any # The unique id for the Automation workflow., workflow_email_id: any # The unique id for the Automation workflow email.}
@returns(200)

@endpoint DELETE /automations/{workflow_id}/emails/{workflow_email_id}
@desc Delete workflow email
@required {workflow_id: any # The unique id for the Automation workflow., workflow_email_id: any # The unique id for the Automation workflow email.}
@returns(204) Empty Response

@endpoint PATCH /automations/{workflow_id}/emails/{workflow_email_id}
@desc Update workflow email
@required {workflow_id: any # The unique id for the Automation workflow., workflow_email_id: any # The unique id for the Automation workflow email., body: map}
@returns(200)

@endpoint GET /automations/{workflow_id}/emails/{workflow_email_id}/queue
@desc List automated email subscribers
@required {workflow_id: any # The unique id for the Automation workflow., workflow_email_id: any # The unique id for the Automation workflow email.}
@returns(200)

@endpoint POST /automations/{workflow_id}/emails/{workflow_email_id}/queue
@desc Add subscriber to workflow email
@required {workflow_id: any # The unique id for the Automation workflow., workflow_email_id: any # The unique id for the Automation workflow email., body: map}
@returns(200)

@endpoint GET /automations/{workflow_id}/emails/{workflow_email_id}/queue/{subscriber_hash}
@desc Get automated email subscriber
@required {workflow_id: any # The unique id for the Automation workflow., workflow_email_id: any # The unique id for the Automation workflow email., subscriber_hash: any # The MD5 hash of the lowercase version of the list member's email address.}
@returns(200)

@endpoint POST /automations/{workflow_id}/emails/{workflow_email_id}/actions/pause
@desc Pause automated email
@required {workflow_id: any # The unique id for the Automation workflow., workflow_email_id: any # The unique id for the Automation workflow email.}
@returns(204) Empty Response

@endpoint POST /automations/{workflow_id}/emails/{workflow_email_id}/actions/start
@desc Start automated email
@required {workflow_id: any # The unique id for the Automation workflow., workflow_email_id: any # The unique id for the Automation workflow email.}
@returns(204) Empty Response

@endpoint GET /automations/{workflow_id}/removed-subscribers
@desc List subscribers removed from workflow
@required {workflow_id: any # The unique id for the Automation workflow.}
@returns(200)

@endpoint POST /automations/{workflow_id}/removed-subscribers
@desc Remove subscriber from workflow
@required {workflow_id: any # The unique id for the Automation workflow., body: map}
@returns(200)

@endpoint GET /automations/{workflow_id}/removed-subscribers/{subscriber_hash}
@desc Get subscriber removed from workflow
@required {workflow_id: any # The unique id for the Automation workflow., subscriber_hash: any # The MD5 hash of the lowercase version of the list member's email address.}
@returns(200)

@endgroup

@group batches
@endpoint GET /batches
@desc List batch requests
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation., count: any # The number of records to return. Default value is 10. Maximum value is 1000, offset: any # 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.}
@returns(200)

@endpoint POST /batches
@desc Start batch operation
@required {body: map}
@returns(200)

@endpoint GET /batches/{batch_id}
@desc Get batch operation status
@required {batch_id: any # The unique id for the batch operation.}
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.}
@returns(200)

@endpoint DELETE /batches/{batch_id}
@desc Delete batch request
@required {batch_id: any # The unique id for the batch operation.}
@returns(204) Empty Response

@endgroup

@group batch-webhooks
@endpoint GET /batch-webhooks
@desc List batch webhooks
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation., count: any # The number of records to return. Default value is 10. Maximum value is 1000, offset: any # 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.}
@returns(200)

@endpoint POST /batch-webhooks
@desc Add batch webhook
@required {body: map}
@returns(200)

@endpoint GET /batch-webhooks/{batch_webhook_id}
@desc Get batch webhook info
@required {batch_webhook_id: any # The unique id for the batch webhook.}
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.}
@returns(200)

@endpoint PATCH /batch-webhooks/{batch_webhook_id}
@desc Update batch webhook
@required {batch_webhook_id: any # The unique id for the batch webhook., body: map}
@returns(200)

@endpoint DELETE /batch-webhooks/{batch_webhook_id}
@desc Delete batch webhook
@required {batch_webhook_id: any # The unique id for the batch webhook.}
@returns(204) Empty Response

@endgroup

@group template-folders
@endpoint GET /template-folders
@desc List template folders
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation., count: any # The number of records to return. Default value is 10. Maximum value is 1000, offset: any # 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.}
@returns(200)

@endpoint POST /template-folders
@desc Add template folder
@required {body: map}
@returns(200)

@endpoint GET /template-folders/{folder_id}
@desc Get template folder
@required {folder_id: any # The unique id for the template folder.}
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.}
@returns(200)

@endpoint PATCH /template-folders/{folder_id}
@desc Update template folder
@required {folder_id: any # The unique id for the template folder., body: map}
@returns(200)

@endpoint DELETE /template-folders/{folder_id}
@desc Delete template folder
@required {folder_id: any # The unique id for the template folder.}
@returns(204) Empty Response

@endgroup

@group campaign-folders
@endpoint GET /campaign-folders
@desc List campaign folders
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation., count: any # The number of records to return. Default value is 10. Maximum value is 1000, offset: any # 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.}
@returns(200)

@endpoint POST /campaign-folders
@desc Add campaign folder
@required {body: map}
@returns(200)

@endpoint GET /campaign-folders/{folder_id}
@desc Get campaign folder
@required {folder_id: any # The unique id for the campaign folder.}
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.}
@returns(200)

@endpoint PATCH /campaign-folders/{folder_id}
@desc Update campaign folder
@required {folder_id: any # The unique id for the campaign folder., body: map}
@returns(200)

@endpoint DELETE /campaign-folders/{folder_id}
@desc Delete campaign folder
@required {folder_id: any # The unique id for the campaign folder.}
@returns(204) Empty Response

@endgroup

@group campaigns
@endpoint GET /campaigns
@desc List campaigns
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation., count: any # The number of records to return. Default value is 10. Maximum value is 1000, offset: any # 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., type: any # The campaign type., status: any # The status of the campaign., before_send_time: any # Restrict the response to campaigns sent before the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00., since_send_time: any # Restrict the response to campaigns sent after the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00., before_create_time: any # Restrict the response to campaigns created before the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00., since_create_time: any # Restrict the response to campaigns created after the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00., list_id: any # The unique id for the list., folder_id: any # The unique folder id., member_id: any # 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., sort_field: any # Returns files sorted by the specified field., sort_dir: any # Determines the order direction for sorted results., include_resend_shortcut_eligibility: any # Return the `resend_shortcut_eligibility` field in the response, which tells you if the campaign is eligible for the various Campaign Resend Shortcuts offered.}
@returns(200)

@endpoint POST /campaigns
@desc Add campaign
@required {body: map}
@returns(200)

@endpoint GET /campaigns/{campaign_id}
@desc Get campaign info
@required {campaign_id: any # The unique id for the campaign.}
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation., include_resend_shortcut_eligibility: any # Return the `resend_shortcut_eligibility` field in the response, which tells you if the campaign is eligible for the various Campaign Resend Shortcuts offered., include_resend_shortcut_usage: any # Return the `resend_shortcut_usage` field in the response.  This includes information about campaigns related by a shortcut.}
@returns(200)

@endpoint PATCH /campaigns/{campaign_id}
@desc Update campaign settings
@required {campaign_id: any # The unique id for the campaign., body: map}
@returns(200)

@endpoint DELETE /campaigns/{campaign_id}
@desc Delete campaign
@required {campaign_id: any # The unique id for the campaign.}
@returns(204) Empty Response

@endpoint POST /campaigns/{campaign_id}/actions/cancel-send
@desc Cancel campaign
@required {campaign_id: any # The unique id for the campaign.}
@returns(204) Empty Response

@endpoint POST /campaigns/{campaign_id}/actions/replicate
@desc Replicate campaign
@required {campaign_id: any # The unique id for the campaign.}
@returns(200)

@endpoint POST /campaigns/{campaign_id}/actions/send
@desc Send campaign
@required {campaign_id: any # The unique id for the campaign.}
@returns(204) Empty Response

@endpoint POST /campaigns/{campaign_id}/actions/schedule
@desc Schedule campaign
@required {campaign_id: any # The unique id for the campaign., body: map}
@returns(204) Empty Response

@endpoint POST /campaigns/{campaign_id}/actions/unschedule
@desc Unschedule campaign
@required {campaign_id: any # The unique id for the campaign.}
@returns(204) Empty Response

@endpoint POST /campaigns/{campaign_id}/actions/test
@desc Send test email
@required {campaign_id: any # The unique id for the campaign., body: map}
@returns(204) Empty Response

@endpoint POST /campaigns/{campaign_id}/actions/pause
@desc Pause rss campaign
@required {campaign_id: any # The unique id for the campaign.}
@returns(204) Empty Response

@endpoint POST /campaigns/{campaign_id}/actions/resume
@desc Resume rss campaign
@required {campaign_id: any # The unique id for the campaign.}
@returns(204) Empty Response

@endpoint POST /campaigns/{campaign_id}/actions/create-resend
@desc Resend campaign
@required {campaign_id: any # The unique id for the campaign.}
@optional {body: map}
@returns(200)

@endpoint GET /campaigns/{campaign_id}/content
@desc Get campaign content
@required {campaign_id: any # The unique id for the campaign.}
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.}
@returns(200)

@endpoint PUT /campaigns/{campaign_id}/content
@desc Set campaign content
@required {campaign_id: any # The unique id for the campaign., body: map}
@returns(200)

@endpoint GET /campaigns/{campaign_id}/feedback
@desc List campaign feedback
@required {campaign_id: any # The unique id for the campaign.}
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.}
@returns(200)

@endpoint POST /campaigns/{campaign_id}/feedback
@desc Add campaign feedback
@required {campaign_id: any # The unique id for the campaign., body: map}
@returns(200)

@endpoint GET /campaigns/{campaign_id}/feedback/{feedback_id}
@desc Get campaign feedback message
@required {campaign_id: any # The unique id for the campaign., feedback_id: any # The unique id for the feedback message.}
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.}
@returns(200)

@endpoint PATCH /campaigns/{campaign_id}/feedback/{feedback_id}
@desc Update campaign feedback message
@required {campaign_id: any # The unique id for the campaign., feedback_id: any # The unique id for the feedback message., body: map}
@returns(200)

@endpoint DELETE /campaigns/{campaign_id}/feedback/{feedback_id}
@desc Delete campaign feedback message
@required {campaign_id: any # The unique id for the campaign., feedback_id: any # The unique id for the feedback message.}
@returns(204) Empty Response

@endpoint GET /campaigns/{campaign_id}/send-checklist
@desc Get campaign send checklist
@required {campaign_id: any # The unique id for the campaign.}
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.}
@returns(200)

@endgroup

@group connected-sites
@endpoint GET /connected-sites
@desc List connected sites
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation., count: any # The number of records to return. Default value is 10. Maximum value is 1000, offset: any # 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.}
@returns(200)

@endpoint POST /connected-sites
@desc Add connected site
@required {body: map}
@returns(200)

@endpoint GET /connected-sites/{connected_site_id}
@desc Get connected site
@required {connected_site_id: any # The unique identifier for the site.}
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.}
@returns(200)

@endpoint DELETE /connected-sites/{connected_site_id}
@desc Delete connected site
@required {connected_site_id: any # The unique identifier for the site.}
@returns(204) Empty Response

@endpoint POST /connected-sites/{connected_site_id}/actions/verify-script-installation
@desc Verify connected site script
@required {connected_site_id: any # The unique identifier for the site.}
@returns(204) Empty Response

@endgroup

@group conversations
@endpoint GET /conversations
@desc List conversations
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation., count: any # The number of records to return. Default value is 10. Maximum value is 1000, offset: any # 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., has_unread_messages: any # Whether the conversation has any unread messages., list_id: any # The unique id for the list., campaign_id: any # The unique id for the campaign.}
@returns(200)

@endpoint GET /conversations/{conversation_id}
@desc Get conversation
@required {conversation_id: any # The unique id for the conversation.}
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.}
@returns(200)

@endpoint GET /conversations/{conversation_id}/messages
@desc List messages
@required {conversation_id: any # The unique id for the conversation.}
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation., is_read: any # Whether a conversation message has been marked as read., before_timestamp: any # Restrict the response to messages created before the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00., since_timestamp: any # Restrict the response to messages created after the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.}
@returns(200)

@endpoint GET /conversations/{conversation_id}/messages/{message_id}
@desc Get message
@required {conversation_id: any # The unique id for the conversation., message_id: any # The unique id for the conversation message.}
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.}
@returns(200)

@endgroup

@group customer-journeys
@endpoint POST /customer-journeys/journeys/{journey_id}/steps/{step_id}/actions/trigger
@desc Customer Journeys API trigger for a contact
@required {journey_id: any # The id for the flow., step_id: any # The id for the Step., body: map}
@returns(204) An empty response

@endgroup

@group file-manager
@endpoint GET /file-manager/files
@desc List stored files
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation., count: any # The number of records to return. Default value is 10. Maximum value is 1000, offset: any # 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., type: any # The file type for the File Manager file., created_by: any # The Mailchimp account user who created the File Manager file., before_created_at: any # Restrict the response to files created before the set date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00., since_created_at: any # Restrict the response to files created after the set date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00., sort_field: any # Returns files sorted by the specified field., sort_dir: any # Determines the order direction for sorted results.}
@returns(200)

@endpoint POST /file-manager/files
@desc Add file
@required {body: map}
@returns(200)

@endpoint GET /file-manager/files/{file_id}
@desc Get file
@required {file_id: any # The unique id for the File Manager file.}
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.}
@returns(200)

@endpoint PATCH /file-manager/files/{file_id}
@desc Update file
@required {file_id: any # The unique id for the File Manager file., body: map}
@returns(200)

@endpoint DELETE /file-manager/files/{file_id}
@desc Delete file
@required {file_id: any # The unique id for the File Manager file.}
@returns(204) Empty Response

@endpoint GET /file-manager/folders
@desc List folders
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation., count: any # The number of records to return. Default value is 10. Maximum value is 1000, offset: any # 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., created_by: any # The Mailchimp account user who created the File Manager file., before_created_at: any # Restrict the response to files created before the set date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00., since_created_at: any # Restrict the response to files created after the set date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.}
@returns(200)

@endpoint POST /file-manager/folders
@desc Add folder
@required {body: map}
@returns(200)

@endpoint GET /file-manager/folders/{folder_id}
@desc Get folder
@required {folder_id: any # The unique id for the File Manager folder.}
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.}
@returns(200)

@endpoint PATCH /file-manager/folders/{folder_id}
@desc Update folder
@required {folder_id: any # The unique id for the File Manager folder., body: map}
@returns(200)

@endpoint DELETE /file-manager/folders/{folder_id}
@desc Delete folder
@required {folder_id: any # The unique id for the File Manager folder.}
@returns(204) Empty Response

@endpoint GET /file-manager/folders/{folder_id}/files
@desc List stored files
@required {folder_id: any # The unique id for the File Manager folder.}
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation., count: any # The number of records to return. Default value is 10. Maximum value is 1000, offset: any # 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., type: any # The file type for the File Manager file., created_by: any # The Mailchimp account user who created the File Manager file., before_created_at: any # Restrict the response to files created before the set date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00., since_created_at: any # Restrict the response to files created after the set date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00., sort_field: any # Returns files sorted by the specified field., sort_dir: any # Determines the order direction for sorted results.}
@returns(200)

@endgroup

@group lists
@endpoint GET /lists
@desc Get lists info
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation., count: any # The number of records to return. Default value is 10. Maximum value is 1000, offset: any # 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., before_date_created: any # Restrict response to lists created before the set date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00., since_date_created: any # Restrict results to lists created after the set date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00., before_campaign_last_sent: any # Restrict results to lists created before the last campaign send date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00., since_campaign_last_sent: any # Restrict results to lists created after the last campaign send date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00., email: any # Restrict results to lists that include a specific subscriber's email address., sort_field: any # Returns files sorted by the specified field., sort_dir: any # Determines the order direction for sorted results., has_ecommerce_store: any # Restrict results to lists that contain an active, connected, undeleted ecommerce store., include_total_contacts: any # Return the total_contacts field in the stats response, which contains an approximate count of all contacts in any state.}
@returns(200)

@endpoint POST /lists
@desc Add list
@required {body: map}
@returns(200)

@endpoint GET /lists/{list_id}
@desc Get list info
@required {list_id: any # The unique ID for the list.}
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation., include_total_contacts: any # Return the total_contacts field in the stats response, which contains an approximate count of all contacts in any state.}
@returns(200)

@endpoint PATCH /lists/{list_id}
@desc Update lists
@required {list_id: any # The unique ID for the list., body: map}
@returns(200)

@endpoint DELETE /lists/{list_id}
@desc Delete list
@required {list_id: any # The unique ID for the list.}
@returns(204) Empty Response

@endpoint POST /lists/{list_id}
@desc Batch subscribe or unsubscribe
@required {list_id: any # The unique ID for the list., body: map}
@optional {skip_merge_validation: any # 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., skip_duplicate_check: any # 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.}
@returns(200)

@endpoint GET /lists/{list_id}/abuse-reports
@desc List abuse reports
@required {list_id: any # The unique ID for the list.}
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation., count: any # The number of records to return. Default value is 10. Maximum value is 1000, offset: any # 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.}
@returns(200)

@endpoint GET /lists/{list_id}/abuse-reports/{report_id}
@desc Get abuse report
@required {list_id: any # The unique ID for the list., report_id: any # The id for the abuse report.}
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation., count: any # The number of records to return. Default value is 10. Maximum value is 1000, offset: any # 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.}
@returns(200)

@endpoint GET /lists/{list_id}/activity
@desc List recent activity
@required {list_id: any # The unique ID for the list.}
@optional {count: any # The number of records to return. Default value is 10. Maximum value is 1000, offset: any # 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., fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.}
@returns(200)

@endpoint GET /lists/{list_id}/clients
@desc List top email clients
@required {list_id: any # The unique ID for the list.}
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.}
@returns(200)

@endpoint GET /lists/{list_id}/growth-history
@desc List growth history data
@required {list_id: any # The unique ID for the list.}
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation., count: any # The number of records to return. Default value is 10. Maximum value is 1000, offset: any # 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., sort_field: any # Returns files sorted by the specified field., sort_dir: any # Determines the order direction for sorted results.}
@returns(200)

@endpoint GET /lists/{list_id}/growth-history/{month}
@desc Get growth history by month
@required {list_id: any # The unique ID for the list., month: any # A specific month of list growth history.}
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.}
@returns(200)

@endpoint GET /lists/{list_id}/interest-categories
@desc List interest categories
@required {list_id: any # The unique ID for the list.}
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation., count: any # The number of records to return. Default value is 10. Maximum value is 1000, offset: any # 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., type: any # Restrict results a type of interest group}
@returns(200)

@endpoint POST /lists/{list_id}/interest-categories
@desc Add interest category
@required {list_id: any # The unique ID for the list., body: map}
@returns(200)

@endpoint GET /lists/{list_id}/interest-categories/{interest_category_id}
@desc Get interest category info
@required {list_id: any # The unique ID for the list., interest_category_id: any # The unique ID for the interest category.}
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.}
@returns(200)

@endpoint PATCH /lists/{list_id}/interest-categories/{interest_category_id}
@desc Update interest category
@required {list_id: any # The unique ID for the list., interest_category_id: any # The unique ID for the interest category., body: map}
@returns(200)

@endpoint DELETE /lists/{list_id}/interest-categories/{interest_category_id}
@desc Delete interest category
@required {list_id: any # The unique ID for the list., interest_category_id: any # The unique ID for the interest category.}
@returns(204) Empty Response

@endpoint GET /lists/{list_id}/interest-categories/{interest_category_id}/interests
@desc List interests in category
@required {list_id: any # The unique ID for the list., interest_category_id: any # The unique ID for the interest category.}
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation., count: any # The number of records to return. Default value is 10. Maximum value is 1000, offset: any # 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.}
@returns(200)

@endpoint POST /lists/{list_id}/interest-categories/{interest_category_id}/interests
@desc Add interest in category
@required {list_id: any # The unique ID for the list., interest_category_id: any # The unique ID for the interest category., body: map}
@returns(200)

@endpoint GET /lists/{list_id}/interest-categories/{interest_category_id}/interests/{interest_id}
@desc Get interest in category
@required {list_id: any # The unique ID for the list., interest_category_id: any # The unique ID for the interest category., interest_id: any # The specific interest or 'group name'.}
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.}
@returns(200)

@endpoint PATCH /lists/{list_id}/interest-categories/{interest_category_id}/interests/{interest_id}
@desc Update interest in category
@required {list_id: any # The unique ID for the list., interest_category_id: any # The unique ID for the interest category., interest_id: any # The specific interest or 'group name'., body: map}
@returns(200)

@endpoint DELETE /lists/{list_id}/interest-categories/{interest_category_id}/interests/{interest_id}
@desc Delete interest in category
@required {list_id: any # The unique ID for the list., interest_category_id: any # The unique ID for the interest category., interest_id: any # The specific interest or 'group name'.}
@returns(204) Empty Response

@endpoint GET /lists/{list_id}/segments
@desc List segments
@required {list_id: any # The unique ID for the list.}
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation., count: any # The number of records to return. Default value is 10. Maximum value is 1000, offset: any # 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., type: any # Limit results based on segment type., since_created_at: any # Restrict results to segments created after the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00., before_created_at: any # Restrict results to segments created before the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00., include_cleaned: any # Include cleaned members in response, include_transactional: any # Include transactional members in response, include_unsubscribed: any # Include unsubscribed members in response, since_updated_at: any # Restrict results to segments update after the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00., before_updated_at: any # Restrict results to segments update before the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.}
@returns(200)

@endpoint POST /lists/{list_id}/segments
@desc Add segment
@required {list_id: any # The unique ID for the list., body: map}
@returns(200)

@endpoint GET /lists/{list_id}/segments/{segment_id}
@desc Get segment info
@required {list_id: any # The unique ID for the list., segment_id: any # The unique id for the segment.}
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation., include_cleaned: any # Include cleaned members in response, include_transactional: any # Include transactional members in response, include_unsubscribed: any # Include unsubscribed members in response}
@returns(200)

@endpoint DELETE /lists/{list_id}/segments/{segment_id}
@desc Delete segment
@required {list_id: any # The unique ID for the list., segment_id: any # The unique id for the segment.}
@returns(204) Empty Response

@endpoint PATCH /lists/{list_id}/segments/{segment_id}
@desc Update segment
@required {list_id: any # The unique ID for the list., segment_id: any # The unique id for the segment., body: map}
@returns(200)

@endpoint POST /lists/{list_id}/segments/{segment_id}
@desc Batch add or remove members
@required {body: map, list_id: any # The unique ID for the list., segment_id: any # The unique id for the segment.}
@returns(200)

@endpoint GET /lists/{list_id}/segments/{segment_id}/members
@desc List members in segment
@required {list_id: any # The unique ID for the list., segment_id: any # The unique id for the segment.}
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation., count: any # The number of records to return. Default value is 10. Maximum value is 1000, offset: any # 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., include_cleaned: any # Include cleaned members in response, include_transactional: any # Include transactional members in response, include_unsubscribed: any # Include unsubscribed members in response}
@returns(200)

@endpoint POST /lists/{list_id}/segments/{segment_id}/members
@desc Add member to segment
@required {list_id: any # The unique ID for the list., segment_id: any # The unique id for the segment., body: map}
@returns(200)

@endpoint DELETE /lists/{list_id}/segments/{segment_id}/members/{subscriber_hash}
@desc Remove list member from segment
@required {list_id: any # The unique ID for the list., segment_id: any # The unique id for the segment., subscriber_hash: any # The MD5 hash of the lowercase version of the list member's email address.}
@returns(204) Empty Response

@endpoint GET /lists/{list_id}/tag-search
@desc Search for tags on a list by name.
@required {list_id: any # The unique ID for the list.}
@optional {name: any # 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.}
@returns(200)

@endpoint GET /lists/{list_id}/members
@desc List members info
@required {list_id: any # The unique ID for the list.}
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation., count: any # The number of records to return. Default value is 10. Maximum value is 1000, offset: any # 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., email_type: any # The email type., status: any # The subscriber's status., since_timestamp_opt: any # Restrict results to subscribers who opted-in after the set timeframe. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00., before_timestamp_opt: any # Restrict results to subscribers who opted-in before the set timeframe. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00., since_last_changed: any # Restrict results to subscribers whose information changed after the set timeframe. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00., before_last_changed: any # Restrict results to subscribers whose information changed before the set timeframe. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00., unique_email_id: any # A unique identifier for the email address across all Mailchimp lists., vip_only: any # 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., interest_category_id: any # The unique id for the interest category., interest_ids: any # 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., interest_match: any # 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., sort_field: any # Returns files sorted by the specified field., sort_dir: any # Determines the order direction for sorted results., since_last_campaign: any # Filter subscribers by those subscribed/unsubscribed/pending/cleaned since last email campaign send. Member status is required to use this filter., unsubscribed_since: any # Filter subscribers by those unsubscribed since a specific date. Using any status other than unsubscribed with this filter will result in an error.}
@returns(200)

@endpoint POST /lists/{list_id}/members
@desc Add member to list
@required {list_id: any # The unique ID for the list., body: map}
@optional {skip_merge_validation: any # 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.}
@returns(200)

@endpoint GET /lists/{list_id}/members/{subscriber_hash}
@desc Get member info
@required {list_id: any # The unique ID for the list., subscriber_hash: any # 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.}
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.}
@returns(200)

@endpoint PUT /lists/{list_id}/members/{subscriber_hash}
@desc Add or update list member
@required {list_id: any # The unique ID for the list., subscriber_hash: any # 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., body: map}
@optional {skip_merge_validation: any # 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.}
@returns(200)

@endpoint PATCH /lists/{list_id}/members/{subscriber_hash}
@desc Update list member
@required {list_id: any # The unique ID for the list., subscriber_hash: any # 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., body: map}
@optional {skip_merge_validation: any # 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.}
@returns(200)

@endpoint DELETE /lists/{list_id}/members/{subscriber_hash}
@desc Archive list member
@required {list_id: any # The unique ID for the list., subscriber_hash: any # 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.}
@returns(204) Empty Response

@endpoint GET /lists/{list_id}/members/{subscriber_hash}/activity
@desc View recent activity 50
@required {list_id: any # The unique ID for the list., subscriber_hash: any # 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.}
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation., action: any # A comma seperated list of actions to return.}
@returns(200)

@endpoint GET /lists/{list_id}/members/{subscriber_hash}/activity-feed
@desc View recent activity
@required {list_id: any # The unique ID for the list., subscriber_hash: any # 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.}
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation., count: any # The number of records to return. Default value is 10. Maximum value is 1000, offset: any # 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., activity_filters: any # A comma-separated list of activity filters that correspond to a set of activity types, e.g "?activity_filters=open,bounce,click".}
@returns(200)

@endpoint GET /lists/{list_id}/members/{subscriber_hash}/tags
@desc List member tags
@required {list_id: any # The unique ID for the list., subscriber_hash: any # 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.}
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation., count: any # The number of records to return. Default value is 10. Maximum value is 1000, offset: any # 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.}
@returns(200)

@endpoint POST /lists/{list_id}/members/{subscriber_hash}/tags
@desc Add or remove member tags
@required {list_id: any # The unique ID for the list., subscriber_hash: any # The MD5 hash of the lowercase version of the list member's email address., body: map}
@returns(204) Empty Response

@endpoint GET /lists/{list_id}/members/{subscriber_hash}/events
@desc List member events
@required {list_id: any # The unique ID for the list., subscriber_hash: any # 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.}
@optional {count: any # The number of records to return. Default value is 10. Maximum value is 1000, offset: any # 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., fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.}
@returns(200)

@endpoint POST /lists/{list_id}/members/{subscriber_hash}/events
@desc Add event
@required {list_id: any # The unique ID for the list., subscriber_hash: any # 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., body: map}
@returns(204) Empty Response

@endpoint GET /lists/{list_id}/members/{subscriber_hash}/goals
@desc List member goal events
@required {list_id: any # The unique ID for the list., subscriber_hash: any # 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.}
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.}
@returns(200)

@endpoint GET /lists/{list_id}/members/{subscriber_hash}/notes
@desc List recent member notes
@required {list_id: any # The unique ID for the list., subscriber_hash: any # The MD5 hash of the lowercase version of the list member's email address.}
@optional {sort_field: any # Returns notes sorted by the specified field., sort_dir: any # Determines the order direction for sorted results., fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation., count: any # The number of records to return. Default value is 10. Maximum value is 1000, offset: any # 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.}
@returns(200)

@endpoint POST /lists/{list_id}/members/{subscriber_hash}/notes
@desc Add member note
@required {list_id: any # The unique ID for the list., subscriber_hash: any # The MD5 hash of the lowercase version of the list member's email address., body: map}
@returns(200)

@endpoint GET /lists/{list_id}/members/{subscriber_hash}/notes/{note_id}
@desc Get member note
@required {list_id: any # The unique ID for the list., subscriber_hash: any # 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., note_id: any # The id for the note.}
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.}
@returns(200)

@endpoint PATCH /lists/{list_id}/members/{subscriber_hash}/notes/{note_id}
@desc Update note
@required {list_id: any # The unique ID for the list., subscriber_hash: any # 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., note_id: any # The id for the note., body: map}
@returns(200)

@endpoint DELETE /lists/{list_id}/members/{subscriber_hash}/notes/{note_id}
@desc Delete note
@required {list_id: any # The unique ID for the list., subscriber_hash: any # 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., note_id: any # The id for the note.}
@returns(204) Empty Response

@endpoint POST /lists/{list_id}/members/{subscriber_hash}/actions/delete-permanent
@desc Delete list member
@required {list_id: any # The unique ID for the list., subscriber_hash: any # The MD5 hash of the lowercase version of the list member's email address.}
@returns(204) Empty Response

@endpoint GET /lists/{list_id}/merge-fields
@desc List merge fields
@required {list_id: any # The unique ID for the list.}
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation., count: any # The number of records to return. Default value is 10. Maximum value is 1000, offset: any # 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., type: any # The merge field type., required: any # Whether it's a required merge field.}
@returns(200)

@endpoint POST /lists/{list_id}/merge-fields
@desc Add merge field
@required {list_id: any # The unique ID for the list., body: map}
@returns(200)

@endpoint GET /lists/{list_id}/merge-fields/{merge_id}
@desc Get merge field
@required {list_id: any # The unique ID for the list., merge_id: any # The id for the merge field.}
@optional {exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation., fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.}
@returns(200)

@endpoint PATCH /lists/{list_id}/merge-fields/{merge_id}
@desc Update merge field
@required {list_id: any # The unique ID for the list., merge_id: any # The id for the merge field., body: map}
@returns(200)

@endpoint DELETE /lists/{list_id}/merge-fields/{merge_id}
@desc Delete merge field
@required {list_id: any # The unique ID for the list., merge_id: any # The id for the merge field.}
@returns(204) Empty Response

@endpoint GET /lists/{list_id}/webhooks
@desc List webhooks
@required {list_id: any # The unique ID for the list.}
@returns(200)

@endpoint POST /lists/{list_id}/webhooks
@desc Add webhook
@required {list_id: any # The unique ID for the list., body: map}
@returns(200)

@endpoint GET /lists/{list_id}/webhooks/{webhook_id}
@desc Get webhook info
@required {list_id: any # The unique ID for the list., webhook_id: any # The webhook's id.}
@returns(200)

@endpoint DELETE /lists/{list_id}/webhooks/{webhook_id}
@desc Delete webhook
@required {list_id: any # The unique ID for the list., webhook_id: any # The webhook's id.}
@returns(204) Empty Response

@endpoint PATCH /lists/{list_id}/webhooks/{webhook_id}
@desc Update webhook
@required {list_id: any # The unique ID for the list., webhook_id: any # The webhook's id., body: map}
@returns(200)

@endpoint GET /lists/{list_id}/signup-forms
@desc List signup forms
@required {list_id: any # The unique ID for the list.}
@returns(200)

@endpoint POST /lists/{list_id}/signup-forms
@desc Customize signup form
@required {list_id: any # The unique ID for the list., body: map}
@returns(200)

@endpoint GET /lists/{list_id}/locations
@desc List locations
@required {list_id: any # The unique ID for the list.}
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.}
@returns(200)

@endpoint GET /lists/{list_id}/surveys
@desc Get information about all surveys for a list
@required {list_id: any # The unique ID for the list.}
@returns(200)

@endpoint GET /lists/{list_id}/surveys/{survey_id}
@desc Get survey
@required {list_id: any # The unique ID for the list., survey_id: any # The ID of the survey.}
@returns(200)

@endpoint POST /lists/{list_id}/surveys/{survey_id}/actions/publish
@desc Publish a Survey
@required {list_id: any # The unique ID for the list., survey_id: any # The ID of the survey.}
@returns(200) Survey Published

@endpoint POST /lists/{list_id}/surveys/{survey_id}/actions/unpublish
@desc Unpublish a Survey
@required {list_id: any # The unique ID for the list., survey_id: any # The ID of the survey.}
@returns(200) Survey Instance

@endpoint POST /lists/{list_id}/surveys/{survey_id}/actions/create-email
@desc Create a Survey Campaign
@required {list_id: any # The unique ID for the list., survey_id: any # The ID of the survey.}
@returns(200) Campaign Instance

@endgroup

@group landing-pages
@endpoint GET /landing-pages
@desc List landing pages
@optional {sort_dir: any # Determines the order direction for sorted results., sort_field: any # Returns files sorted by the specified field., fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation., count: any # The number of records to return. Default value is 10. Maximum value is 1000}
@returns(200) Landing Pages Collection

@endpoint POST /landing-pages
@desc Add landing page
@required {body: map}
@optional {use_default_list: any # Will create the Landing Page using the account's Default List instead of requiring a list_id.}
@returns(200)

@endpoint GET /landing-pages/{page_id}
@desc Get landing page info
@required {page_id: any # The unique id for the page.}
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.}
@returns(200) Landing Pages Instance

@endpoint PATCH /landing-pages/{page_id}
@desc Update landing page
@required {page_id: any # The unique id for the page., body: map}
@returns(200)

@endpoint DELETE /landing-pages/{page_id}
@desc Delete landing page
@required {page_id: any # The unique id for the page.}
@returns(204) Empty Response

@endpoint POST /landing-pages/{page_id}/actions/publish
@desc Publish landing page
@required {page_id: any # The unique id for the page.}
@returns(204) Empty Response

@endpoint POST /landing-pages/{page_id}/actions/unpublish
@desc Unpublish landing page
@required {page_id: any # The unique id for the page.}
@returns(204) Empty Response

@endpoint GET /landing-pages/{page_id}/content
@desc Get landing page content
@required {page_id: any # The unique id for the page.}
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.}
@returns(200)

@endgroup

@group reports
@endpoint GET /reports
@desc List campaign reports
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation., count: any # The number of records to return. Default value is 10. Maximum value is 1000, offset: any # 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., type: any # The campaign type., before_send_time: any # Restrict the response to campaigns sent before the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00., since_send_time: any # Restrict the response to campaigns sent after the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.}
@returns(200)

@endpoint GET /reports/{campaign_id}
@desc Get campaign report
@required {campaign_id: any # The unique id for the campaign.}
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.}
@returns(200)

@endpoint GET /reports/{campaign_id}/abuse-reports
@desc List abuse reports
@required {campaign_id: any # The unique id for the campaign.}
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.}
@returns(200)

@endpoint GET /reports/{campaign_id}/abuse-reports/{report_id}
@desc Get abuse report
@required {campaign_id: any # The unique id for the campaign., report_id: any # The id for the abuse report.}
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.}
@returns(200)

@endpoint GET /reports/{campaign_id}/advice
@desc List campaign feedback
@required {campaign_id: any # The unique id for the campaign.}
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.}
@returns(200)

@endpoint GET /reports/{campaign_id}/click-details
@desc List campaign details
@required {campaign_id: any # The unique id for the campaign.}
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation., count: any # The number of records to return. Default value is 10. Maximum value is 1000, offset: any # 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., sort_field: any # Returns click reports sorted by the specified field., sort_dir: any # Determines the order direction for sorted results.}
@returns(200)

@endpoint GET /reports/{campaign_id}/click-details/{link_id}
@desc Get campaign link details
@required {campaign_id: any # The unique id for the campaign., link_id: any # The id for the link.}
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.}
@returns(200)

@endpoint GET /reports/{campaign_id}/click-details/{link_id}/members
@desc List clicked link subscribers
@required {campaign_id: any # The unique id for the campaign., link_id: any # The id for the link.}
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation., count: any # The number of records to return. Default value is 10. Maximum value is 1000, offset: any # 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.}
@returns(200)

@endpoint GET /reports/{campaign_id}/click-details/{link_id}/members/{subscriber_hash}
@desc Get clicked link subscriber
@required {campaign_id: any # The unique id for the campaign., link_id: any # The id for the link., subscriber_hash: any # The MD5 hash of the lowercase version of the list member's email address.}
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.}
@returns(200)

@endpoint GET /reports/{campaign_id}/open-details
@desc List campaign open details
@required {campaign_id: any # The unique id for the campaign.}
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation., count: any # The number of records to return. Default value is 10. Maximum value is 1000, offset: any # 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., since: any # Restrict results to campaign open events that occur after a specific time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00., sort_field: any # Returns open reports sorted by the specified field., sort_dir: any # Determines the order direction for sorted results.}
@returns(200)

@endpoint GET /reports/{campaign_id}/open-details/{subscriber_hash}
@desc Get opened campaign subscriber
@required {campaign_id: any # The unique id for the campaign., subscriber_hash: any # The MD5 hash of the lowercase version of the list member's email address.}
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.}
@returns(200)

@endpoint GET /reports/{campaign_id}/domain-performance
@desc List domain performance stats
@required {campaign_id: any # The unique id for the campaign.}
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.}
@returns(200)

@endpoint GET /reports/{campaign_id}/eepurl
@desc List EepURL activity
@required {campaign_id: any # The unique id for the campaign.}
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.}
@returns(200)

@endpoint GET /reports/{campaign_id}/email-activity
@desc List email activity
@required {campaign_id: any # The unique id for the campaign.}
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation., count: any # The number of records to return. Default value is 10. Maximum value is 1000, offset: any # 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., since: any # Restrict results to email activity events that occur after a specific time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.}
@returns(200)

@endpoint GET /reports/{campaign_id}/email-activity/{subscriber_hash}
@desc Get subscriber email activity
@required {campaign_id: any # The unique id for the campaign., subscriber_hash: any # The MD5 hash of the lowercase version of the list member's email address.}
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation., since: any # Restrict results to email activity events that occur after a specific time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.}
@returns(200)

@endpoint GET /reports/{campaign_id}/locations
@desc List top open activities
@required {campaign_id: any # The unique id for the campaign.}
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation., count: any # The number of records to return. Default value is 10. Maximum value is 1000, offset: any # 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.}
@returns(200)

@endpoint GET /reports/{campaign_id}/sent-to
@desc List campaign recipients
@required {campaign_id: any # The unique id for the campaign.}
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation., count: any # The number of records to return. Default value is 10. Maximum value is 1000, offset: any # 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.}
@returns(200)

@endpoint GET /reports/{campaign_id}/sent-to/{subscriber_hash}
@desc Get campaign recipient info
@required {campaign_id: any # The unique id for the campaign., subscriber_hash: any # The MD5 hash of the lowercase version of the list member's email address.}
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.}
@returns(200)

@endpoint GET /reports/{campaign_id}/sub-reports
@desc List child campaign reports
@required {campaign_id: any # The unique id for the campaign.}
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.}
@returns(200)

@endpoint GET /reports/{campaign_id}/unsubscribed
@desc List unsubscribed members
@required {campaign_id: any # The unique id for the campaign.}
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation., count: any # The number of records to return. Default value is 10. Maximum value is 1000, offset: any # 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.}
@returns(200)

@endpoint GET /reports/{campaign_id}/unsubscribed/{subscriber_hash}
@desc Get unsubscribed member
@required {campaign_id: any # The unique id for the campaign., subscriber_hash: any # The MD5 hash of the lowercase version of the list member's email address.}
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.}
@returns(200)

@endpoint GET /reports/{campaign_id}/ecommerce-product-activity
@desc List campaign product activity
@required {campaign_id: any # The unique id for the campaign.}
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation., count: any # The number of records to return. Default value is 10. Maximum value is 1000, offset: any # 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., sort_field: any # Returns files sorted by the specified field.}
@returns(200) Ecommerce Product Activity Instance

@endgroup

@group templates
@endpoint GET /templates
@desc List templates
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation., count: any # The number of records to return. Default value is 10. Maximum value is 1000, offset: any # 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., created_by: any # The Mailchimp account user who created the template., since_date_created: any # Restrict the response to templates created after the set date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00., before_date_created: any # Restrict the response to templates created before the set date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00., type: any # Limit results based on template type., category: any # Limit results based on category., folder_id: any # The unique folder id., sort_field: any # Returns user templates sorted by the specified field., content_type: any # 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`., sort_dir: any # Determines the order direction for sorted results.}
@returns(200)

@endpoint POST /templates
@desc Add template
@required {body: map}
@returns(200)

@endpoint GET /templates/{template_id}
@desc Get template info
@required {template_id: any # The unique id for the template.}
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.}
@returns(200)

@endpoint PATCH /templates/{template_id}
@desc Update template
@required {template_id: any # The unique id for the template., body: map}
@returns(200)

@endpoint DELETE /templates/{template_id}
@desc Delete template
@required {template_id: any # The unique id for the template.}
@returns(204) Empty Response

@endpoint GET /templates/{template_id}/default-content
@desc View default content
@required {template_id: any # The unique id for the template.}
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.}
@returns(200)

@endgroup

@group ecommerce
@endpoint GET /ecommerce/orders
@desc List account orders
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation., count: any # The number of records to return. Default value is 10. Maximum value is 1000, offset: any # 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., campaign_id: any # Restrict results to orders with a specific `campaign_id` value., outreach_id: any # Restrict results to orders with a specific `outreach_id` value., customer_id: any # Restrict results to orders made by a specific customer., has_outreach: any # Restrict results to orders that have an outreach attached. For example, an email campaign or Facebook ad.}
@returns(200)

@endpoint GET /ecommerce/stores
@desc List stores
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation., count: any # The number of records to return. Default value is 10. Maximum value is 1000, offset: any # 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.}
@returns(200)

@endpoint POST /ecommerce/stores
@desc Add store
@required {body: map}
@returns(200)

@endpoint GET /ecommerce/stores/{store_id}
@desc Get store info
@required {store_id: any # The store id.}
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.}
@returns(200)

@endpoint PATCH /ecommerce/stores/{store_id}
@desc Update store
@required {store_id: any # The store id., body: map}
@returns(200)

@endpoint DELETE /ecommerce/stores/{store_id}
@desc Delete store
@required {store_id: any # The store id.}
@returns(204) Empty Response

@endpoint GET /ecommerce/stores/{store_id}/carts
@desc List carts
@required {store_id: any # The store id.}
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation., count: any # The number of records to return. Default value is 10. Maximum value is 1000, offset: any # 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.}
@returns(200)

@endpoint POST /ecommerce/stores/{store_id}/carts
@desc Add cart
@required {store_id: any # The store id., body: map}
@returns(200)

@endpoint GET /ecommerce/stores/{store_id}/carts/{cart_id}
@desc Get cart info
@required {store_id: any # The store id., cart_id: any # The id for the cart.}
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.}
@returns(200)

@endpoint PATCH /ecommerce/stores/{store_id}/carts/{cart_id}
@desc Update cart
@required {store_id: any # The store id., cart_id: any # The id for the cart., body: map}
@returns(200)

@endpoint DELETE /ecommerce/stores/{store_id}/carts/{cart_id}
@desc Delete cart
@required {store_id: any # The store id., cart_id: any # The id for the cart.}
@returns(204) Empty Response

@endpoint GET /ecommerce/stores/{store_id}/carts/{cart_id}/lines
@desc List cart line items
@required {store_id: any # The store id., cart_id: any # The id for the cart.}
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation., count: any # The number of records to return. Default value is 10. Maximum value is 1000, offset: any # 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.}
@returns(200)

@endpoint POST /ecommerce/stores/{store_id}/carts/{cart_id}/lines
@desc Add cart line item
@required {store_id: any # The store id., cart_id: any # The id for the cart., body: map}
@returns(200)

@endpoint GET /ecommerce/stores/{store_id}/carts/{cart_id}/lines/{line_id}
@desc Get cart line item
@required {store_id: any # The store id., cart_id: any # The id for the cart., line_id: any # The id for the line item of a cart.}
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.}
@returns(200)

@endpoint PATCH /ecommerce/stores/{store_id}/carts/{cart_id}/lines/{line_id}
@desc Update cart line item
@required {store_id: any # The store id., cart_id: any # The id for the cart., line_id: any # The id for the line item of a cart., body: map}
@returns(200)

@endpoint DELETE /ecommerce/stores/{store_id}/carts/{cart_id}/lines/{line_id}
@desc Delete cart line item
@required {store_id: any # The store id., cart_id: any # The id for the cart., line_id: any # The id for the line item of a cart.}
@returns(204) Empty Response

@endpoint GET /ecommerce/stores/{store_id}/customers
@desc List customers
@required {store_id: any # The store id.}
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation., count: any # The number of records to return. Default value is 10. Maximum value is 1000, offset: any # 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., email_address: any # Restrict the response to customers with the email address.}
@returns(200)

@endpoint POST /ecommerce/stores/{store_id}/customers
@desc Add customer
@required {store_id: any # The store id., body: map}
@returns(200)

@endpoint GET /ecommerce/stores/{store_id}/customers/{customer_id}
@desc Get customer info
@required {store_id: any # The store id., customer_id: any # The id for the customer of a store.}
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.}
@returns(200)

@endpoint PUT /ecommerce/stores/{store_id}/customers/{customer_id}
@desc Add or update customer
@required {store_id: any # The store id., customer_id: any # The id for the customer of a store., body: map}
@returns(200)

@endpoint PATCH /ecommerce/stores/{store_id}/customers/{customer_id}
@desc Update customer
@required {store_id: any # The store id., customer_id: any # The id for the customer of a store., body: map}
@returns(200)

@endpoint DELETE /ecommerce/stores/{store_id}/customers/{customer_id}
@desc Delete customer
@required {store_id: any # The store id., customer_id: any # The id for the customer of a store.}
@returns(204) Empty Response

@endpoint GET /ecommerce/stores/{store_id}/promo-rules
@desc List promo rules
@required {store_id: any # The store id.}
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation., count: any # The number of records to return. Default value is 10. Maximum value is 1000, offset: any # 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.}
@returns(200)

@endpoint POST /ecommerce/stores/{store_id}/promo-rules
@desc Add promo rule
@required {store_id: any # The store id., body: map}
@returns(200)

@endpoint GET /ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}
@desc Get promo rule
@required {store_id: any # The store id., promo_rule_id: any # The id for the promo rule of a store.}
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.}
@returns(200)

@endpoint PATCH /ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}
@desc Update promo rule
@required {store_id: any # The store id., promo_rule_id: any # The id for the promo rule of a store., body: map}
@returns(200)

@endpoint DELETE /ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}
@desc Delete promo rule
@required {store_id: any # The store id., promo_rule_id: any # The id for the promo rule of a store.}
@returns(204) Empty Response

@endpoint GET /ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}/promo-codes
@desc List promo codes
@required {promo_rule_id: any # The id for the promo rule of a store., store_id: any # The store id.}
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation., count: any # The number of records to return. Default value is 10. Maximum value is 1000, offset: any # 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.}
@returns(200)

@endpoint POST /ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}/promo-codes
@desc Add promo code
@required {store_id: any # The store id., promo_rule_id: any # The id for the promo rule of a store., body: map}
@returns(200)

@endpoint GET /ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}/promo-codes/{promo_code_id}
@desc Get promo code
@required {store_id: any # The store id., promo_rule_id: any # The id for the promo rule of a store., promo_code_id: any # The id for the promo code of a store.}
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.}
@returns(200)

@endpoint PATCH /ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}/promo-codes/{promo_code_id}
@desc Update promo code
@required {store_id: any # The store id., promo_rule_id: any # The id for the promo rule of a store., promo_code_id: any # The id for the promo code of a store., body: map}
@returns(200)

@endpoint DELETE /ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}/promo-codes/{promo_code_id}
@desc Delete promo code
@required {store_id: any # The store id., promo_rule_id: any # The id for the promo rule of a store., promo_code_id: any # The id for the promo code of a store.}
@returns(204) Empty Response

@endpoint GET /ecommerce/stores/{store_id}/orders
@desc List orders
@required {store_id: any # The store id.}
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation., count: any # The number of records to return. Default value is 10. Maximum value is 1000, offset: any # 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., customer_id: any # Restrict results to orders made by a specific customer., has_outreach: any # Restrict results to orders that have an outreach attached. For example, an email campaign or Facebook ad., campaign_id: any # Restrict results to orders with a specific `campaign_id` value., outreach_id: any # Restrict results to orders with a specific `outreach_id` value.}
@returns(200)

@endpoint POST /ecommerce/stores/{store_id}/orders
@desc Add order
@required {store_id: any # The store id., body: map}
@returns(200)

@endpoint GET /ecommerce/stores/{store_id}/orders/{order_id}
@desc Get order info
@required {store_id: any # The store id., order_id: any # The id for the order in a store.}
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.}
@returns(200)

@endpoint PUT /ecommerce/stores/{store_id}/orders/{order_id}
@desc Add or update order
@required {store_id: any # The store id., order_id: any # The id for the order in a store., body: map}
@returns(200)

@endpoint PATCH /ecommerce/stores/{store_id}/orders/{order_id}
@desc Update order
@required {store_id: any # The store id., order_id: any # The id for the order in a store., body: map}
@returns(200)

@endpoint DELETE /ecommerce/stores/{store_id}/orders/{order_id}
@desc Delete order
@required {store_id: any # The store id., order_id: any # The id for the order in a store.}
@returns(204) Empty Response

@endpoint GET /ecommerce/stores/{store_id}/orders/{order_id}/lines
@desc List order line items
@required {store_id: any # The store id., order_id: any # The id for the order in a store.}
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation., count: any # The number of records to return. Default value is 10. Maximum value is 1000, offset: any # 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.}
@returns(200)

@endpoint POST /ecommerce/stores/{store_id}/orders/{order_id}/lines
@desc Add order line item
@required {store_id: any # The store id., order_id: any # The id for the order in a store., body: map}
@returns(200)

@endpoint GET /ecommerce/stores/{store_id}/orders/{order_id}/lines/{line_id}
@desc Get order line item
@required {store_id: any # The store id., order_id: any # The id for the order in a store., line_id: any # The id for the line item of an order.}
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.}
@returns(200)

@endpoint PATCH /ecommerce/stores/{store_id}/orders/{order_id}/lines/{line_id}
@desc Update order line item
@required {store_id: any # The store id., order_id: any # The id for the order in a store., line_id: any # The id for the line item of an order., body: map}
@returns(200)

@endpoint DELETE /ecommerce/stores/{store_id}/orders/{order_id}/lines/{line_id}
@desc Delete order line item
@required {store_id: any # The store id., order_id: any # The id for the order in a store., line_id: any # The id for the line item of an order.}
@returns(204) Empty Response

@endpoint GET /ecommerce/stores/{store_id}/products
@desc List product
@required {store_id: any # The store id.}
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation., count: any # The number of records to return. Default value is 10. Maximum value is 1000, offset: any # 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.}
@returns(200)

@endpoint POST /ecommerce/stores/{store_id}/products
@desc Add product
@required {store_id: any # The store id., body: map}
@returns(200)

@endpoint GET /ecommerce/stores/{store_id}/products/{product_id}
@desc Get product info
@required {store_id: any # The store id., product_id: any # The id for the product of a store.}
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.}
@returns(200)

@endpoint PATCH /ecommerce/stores/{store_id}/products/{product_id}
@desc Update product
@required {store_id: any # The store id., product_id: any # The id for the product of a store., body: map}
@returns(200)

@endpoint PUT /ecommerce/stores/{store_id}/products/{product_id}
@desc Create or update product
@required {store_id: any # The store id., product_id: any # The id for the product of a store., body: map}
@returns(200)

@endpoint DELETE /ecommerce/stores/{store_id}/products/{product_id}
@desc Delete product
@required {store_id: any # The store id., product_id: any # The id for the product of a store.}
@returns(204) Empty Response

@endpoint GET /ecommerce/stores/{store_id}/products/{product_id}/variants
@desc List product variants
@required {store_id: any # The store id., product_id: any # The id for the product of a store.}
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation., count: any # The number of records to return. Default value is 10. Maximum value is 1000, offset: any # 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.}
@returns(200)

@endpoint POST /ecommerce/stores/{store_id}/products/{product_id}/variants
@desc Add product variant
@required {store_id: any # The store id., product_id: any # The id for the product of a store., body: map}
@returns(200)

@endpoint GET /ecommerce/stores/{store_id}/products/{product_id}/variants/{variant_id}
@desc Get product variant info
@required {store_id: any # The store id., product_id: any # The id for the product of a store., variant_id: any # The id for the product variant.}
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.}
@returns(200)

@endpoint PUT /ecommerce/stores/{store_id}/products/{product_id}/variants/{variant_id}
@desc Add or update product variant
@required {store_id: any # The store id., product_id: any # The id for the product of a store., variant_id: any # The id for the product variant., body: map}
@returns(200)

@endpoint PATCH /ecommerce/stores/{store_id}/products/{product_id}/variants/{variant_id}
@desc Update product variant
@required {store_id: any # The store id., product_id: any # The id for the product of a store., variant_id: any # The id for the product variant., body: map}
@returns(200)

@endpoint DELETE /ecommerce/stores/{store_id}/products/{product_id}/variants/{variant_id}
@desc Delete product variant
@required {store_id: any # The store id., product_id: any # The id for the product of a store., variant_id: any # The id for the product variant.}
@returns(204) Empty Response

@endpoint GET /ecommerce/stores/{store_id}/products/{product_id}/images
@desc List product images
@required {store_id: any # The store id., product_id: any # The id for the product of a store.}
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation., count: any # The number of records to return. Default value is 10. Maximum value is 1000, offset: any # 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.}
@returns(200)

@endpoint POST /ecommerce/stores/{store_id}/products/{product_id}/images
@desc Add product image
@required {store_id: any # The store id., product_id: any # The id for the product of a store., body: map}
@returns(200)

@endpoint GET /ecommerce/stores/{store_id}/products/{product_id}/images/{image_id}
@desc Get product image info
@required {store_id: any # The store id., product_id: any # The id for the product of a store., image_id: any # The id for the product image.}
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.}
@returns(200)

@endpoint PATCH /ecommerce/stores/{store_id}/products/{product_id}/images/{image_id}
@desc Update product image
@required {store_id: any # The store id., product_id: any # The id for the product of a store., image_id: any # The id for the product image., body: map}
@returns(200)

@endpoint DELETE /ecommerce/stores/{store_id}/products/{product_id}/images/{image_id}
@desc Delete product image
@required {store_id: any # The store id., product_id: any # The id for the product of a store., image_id: any # The id for the product image.}
@returns(204) Empty Response

@endgroup

@group search-campaigns
@endpoint GET /search-campaigns
@desc Search campaigns
@required {query: any # The search query used to filter results.}
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.}
@returns(200)

@endgroup

@group search-members
@endpoint GET /search-members
@desc Search members
@required {query: any # The search query used to filter results. Query should be a valid email, or a string representing a contact's first or last name.}
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation., list_id: any # The unique id for the list.}
@returns(200)

@endgroup

@group ping
@endpoint GET /ping
@desc Ping
@returns(200)

@endgroup

@group facebook-ads
@endpoint GET /facebook-ads
@desc List facebook ads
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation., count: any # The number of records to return. Default value is 10. Maximum value is 1000, offset: any # 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., sort_field: any # Returns files sorted by the specified field., sort_dir: any # Determines the order direction for sorted results.}
@returns(200) List of Facebook Ad Instances

@endpoint GET /facebook-ads/{outreach_id}
@desc Get facebook ad info
@required {outreach_id: any # The outreach id.}
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.}
@returns(200) Facebook Ad Instance

@endgroup

@group reporting
@endpoint GET /reporting/facebook-ads
@desc List facebook ads reports
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation., count: any # The number of records to return. Default value is 10. Maximum value is 1000, offset: any # 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., sort_field: any # Returns files sorted by the specified field., sort_dir: any # Determines the order direction for sorted results.}
@returns(200) List of Facebook Ad Report Instances

@endpoint GET /reporting/facebook-ads/{outreach_id}
@desc Get facebook ad report
@required {outreach_id: any # The outreach id.}
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.}
@returns(200) Facebook Ad report Instance

@endpoint GET /reporting/facebook-ads/{outreach_id}/ecommerce-product-activity
@desc List facebook ecommerce report
@required {outreach_id: any # The outreach id.}
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation., count: any # The number of records to return. Default value is 10. Maximum value is 1000, offset: any # 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., sort_field: any # Returns files sorted by the specified field.}
@returns(200) Ecommerce Product Activity Instance

@endpoint GET /reporting/landing-pages/{outreach_id}
@desc Get landing page report
@required {outreach_id: any # The outreach id.}
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.}
@returns(200) Landing Page Report Instance

@endpoint GET /reporting/landing-pages
@desc List landing pages reports
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation., count: any # The number of records to return. Default value is 10. Maximum value is 1000, offset: any # 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.}
@returns(200) List of Landing Page Report Instances

@endpoint GET /reporting/surveys
@desc List survey reports
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation., count: any # The number of records to return. Default value is 10. Maximum value is 1000, offset: any # 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.}
@returns(200) List of Survey Report Instances

@endpoint GET /reporting/surveys/{survey_id}
@desc Get survey report
@required {survey_id: any # The ID of the survey.}
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.}
@returns(200) Survey Report Instance

@endpoint GET /reporting/surveys/{survey_id}/questions
@desc List survey question reports
@required {survey_id: any # The ID of the survey.}
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.}
@returns(200) List of Survey Question Report Instances

@endpoint GET /reporting/surveys/{survey_id}/questions/{question_id}
@desc Get survey question report
@required {survey_id: any # The ID of the survey., question_id: any # The ID of the survey question.}
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.}
@returns(200) Survey Question Report Instance

@endpoint GET /reporting/surveys/{survey_id}/questions/{question_id}/answers
@desc List answers for question
@required {survey_id: any # The ID of the survey., question_id: any # The ID of the survey question.}
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation., respondent_familiarity_is: any # Filter survey responses by familiarity of the respondents.}
@returns(200) List of Survey Question Answers

@endpoint GET /reporting/surveys/{survey_id}/responses
@desc List survey responses
@required {survey_id: any # The ID of the survey.}
@optional {fields: any # A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation., exclude_fields: any # A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation., answered_question: any # The ID of the question that was answered., chose_answer: any # The ID of the option chosen to filter responses on., respondent_familiarity_is: any # Filter survey responses by familiarity of the respondents.}
@returns(200) List of survey responses

@endpoint GET /reporting/surveys/{survey_id}/responses/{response_id}
@desc Get survey response
@required {survey_id: any # The ID of the survey., response_id: any # The ID of the survey response.}
@returns(200) Get a single survey response.

@endgroup

@group verified-domains
@endpoint GET /verified-domains/{domain_name}
@desc Get domain info
@required {domain_name: any # The domain name.}
@returns(200)

@endpoint DELETE /verified-domains/{domain_name}
@desc Delete domain
@required {domain_name: any # The domain name.}
@returns(204) Empty Response

@endpoint POST /verified-domains/{domain_name}/actions/verify
@desc Verify domain
@required {domain_name: any # The domain name., body: map}
@returns(200) The domain being verified for sending.

@endpoint GET /verified-domains
@desc List sending domains
@returns(200) The domains on the account.

@endpoint POST /verified-domains
@desc Add domain to account
@required {body: map}
@returns(200) The newly-created domain.

@endgroup

@end