{"files":{"SKILL.md":"---\nname: mailchimp-marketing-api\ndescription: \"Mailchimp Marketing API skill. Use when working with Mailchimp Marketing for root, activity-feed, account-exports. Covers 282 endpoints.\"\nversion: 1.0.0\ngenerator: lapsh\n---\n\n# Mailchimp Marketing API\nAPI version: 3.0.91\n\n## Auth\nbasic\n\n## Base URL\nhttps://server.api.mailchimp.com/3.0\n\n## Setup\n1. Configure auth: basic\n2. GET / -- list api root resources\n3. POST /account-exports -- create first account-export\n\n## Endpoints\n282 endpoints across 26 groups. See references/api-spec.lap for full details.\n\n### Root\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | / | List api root resources |\n\n### Activity-feed\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /activity-feed/chimp-chatter | Get latest chimp chatter |\n\n### Account-exports\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /account-exports | List account exports |\n| POST | /account-exports | Add export |\n| GET | /account-exports/{export_id} | Get account export info |\n\n### Audiences\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /audiences | Get a list of audiences |\n| GET | /audiences/{audience_id} | Get audience info |\n| GET | /audiences/{audience_id}/contacts | Get Contacts |\n| POST | /audiences/{audience_id}/contacts | Add Contact |\n| GET | /audiences/{audience_id}/contacts/{contact_id} | Get Contact |\n| PATCH | /audiences/{audience_id}/contacts/{contact_id} | Update Contact |\n| POST | /audiences/{audience_id}/contacts/{contact_id}/actions/archive | Archive Contact |\n| POST | /audiences/{audience_id}/contacts/{contact_id}/actions/forget | Forget Contact |\n\n### Authorized-apps\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /authorized-apps | List authorized apps |\n| GET | /authorized-apps/{app_id} | Get authorized app info |\n\n### Automations\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /automations | List automations |\n| POST | /automations | Add automation |\n| GET | /automations/{workflow_id} | Get automation info |\n| POST | /automations/{workflow_id}/actions/pause-all-emails | Pause automation emails |\n| POST | /automations/{workflow_id}/actions/start-all-emails | Start automation emails |\n| POST | /automations/{workflow_id}/actions/archive | Archive automation |\n| GET | /automations/{workflow_id}/emails | List automated emails |\n| GET | /automations/{workflow_id}/emails/{workflow_email_id} | Get workflow email info |\n| DELETE | /automations/{workflow_id}/emails/{workflow_email_id} | Delete workflow email |\n| PATCH | /automations/{workflow_id}/emails/{workflow_email_id} | Update workflow email |\n| GET | /automations/{workflow_id}/emails/{workflow_email_id}/queue | List automated email subscribers |\n| POST | /automations/{workflow_id}/emails/{workflow_email_id}/queue | Add subscriber to workflow email |\n| GET | /automations/{workflow_id}/emails/{workflow_email_id}/queue/{subscriber_hash} | Get automated email subscriber |\n| POST | /automations/{workflow_id}/emails/{workflow_email_id}/actions/pause | Pause automated email |\n| POST | /automations/{workflow_id}/emails/{workflow_email_id}/actions/start | Start automated email |\n| GET | /automations/{workflow_id}/removed-subscribers | List subscribers removed from workflow |\n| POST | /automations/{workflow_id}/removed-subscribers | Remove subscriber from workflow |\n| GET | /automations/{workflow_id}/removed-subscribers/{subscriber_hash} | Get subscriber removed from workflow |\n\n### Batches\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /batches | List batch requests |\n| POST | /batches | Start batch operation |\n| GET | /batches/{batch_id} | Get batch operation status |\n| DELETE | /batches/{batch_id} | Delete batch request |\n\n### Batch-webhooks\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /batch-webhooks | List batch webhooks |\n| POST | /batch-webhooks | Add batch webhook |\n| GET | /batch-webhooks/{batch_webhook_id} | Get batch webhook info |\n| PATCH | /batch-webhooks/{batch_webhook_id} | Update batch webhook |\n| DELETE | /batch-webhooks/{batch_webhook_id} | Delete batch webhook |\n\n### Template-folders\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /template-folders | List template folders |\n| POST | /template-folders | Add template folder |\n| GET | /template-folders/{folder_id} | Get template folder |\n| PATCH | /template-folders/{folder_id} | Update template folder |\n| DELETE | /template-folders/{folder_id} | Delete template folder |\n\n### Campaign-folders\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /campaign-folders | List campaign folders |\n| POST | /campaign-folders | Add campaign folder |\n| GET | /campaign-folders/{folder_id} | Get campaign folder |\n| PATCH | /campaign-folders/{folder_id} | Update campaign folder |\n| DELETE | /campaign-folders/{folder_id} | Delete campaign folder |\n\n### Campaigns\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /campaigns | List campaigns |\n| POST | /campaigns | Add campaign |\n| GET | /campaigns/{campaign_id} | Get campaign info |\n| PATCH | /campaigns/{campaign_id} | Update campaign settings |\n| DELETE | /campaigns/{campaign_id} | Delete campaign |\n| POST | /campaigns/{campaign_id}/actions/cancel-send | Cancel campaign |\n| POST | /campaigns/{campaign_id}/actions/replicate | Replicate campaign |\n| POST | /campaigns/{campaign_id}/actions/send | Send campaign |\n| POST | /campaigns/{campaign_id}/actions/schedule | Schedule campaign |\n| POST | /campaigns/{campaign_id}/actions/unschedule | Unschedule campaign |\n| POST | /campaigns/{campaign_id}/actions/test | Send test email |\n| POST | /campaigns/{campaign_id}/actions/pause | Pause rss campaign |\n| POST | /campaigns/{campaign_id}/actions/resume | Resume rss campaign |\n| POST | /campaigns/{campaign_id}/actions/create-resend | Resend campaign |\n| GET | /campaigns/{campaign_id}/content | Get campaign content |\n| PUT | /campaigns/{campaign_id}/content | Set campaign content |\n| GET | /campaigns/{campaign_id}/feedback | List campaign feedback |\n| POST | /campaigns/{campaign_id}/feedback | Add campaign feedback |\n| GET | /campaigns/{campaign_id}/feedback/{feedback_id} | Get campaign feedback message |\n| PATCH | /campaigns/{campaign_id}/feedback/{feedback_id} | Update campaign feedback message |\n| DELETE | /campaigns/{campaign_id}/feedback/{feedback_id} | Delete campaign feedback message |\n| GET | /campaigns/{campaign_id}/send-checklist | Get campaign send checklist |\n\n### Connected-sites\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /connected-sites | List connected sites |\n| POST | /connected-sites | Add connected site |\n| GET | /connected-sites/{connected_site_id} | Get connected site |\n| DELETE | /connected-sites/{connected_site_id} | Delete connected site |\n| POST | /connected-sites/{connected_site_id}/actions/verify-script-installation | Verify connected site script |\n\n### Conversations\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /conversations | List conversations |\n| GET | /conversations/{conversation_id} | Get conversation |\n| GET | /conversations/{conversation_id}/messages | List messages |\n| GET | /conversations/{conversation_id}/messages/{message_id} | Get message |\n\n### Customer-journeys\n| Method | Path | Description |\n|--------|------|-------------|\n| POST | /customer-journeys/journeys/{journey_id}/steps/{step_id}/actions/trigger | Customer Journeys API trigger for a contact |\n\n### File-manager\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /file-manager/files | List stored files |\n| POST | /file-manager/files | Add file |\n| GET | /file-manager/files/{file_id} | Get file |\n| PATCH | /file-manager/files/{file_id} | Update file |\n| DELETE | /file-manager/files/{file_id} | Delete file |\n| GET | /file-manager/folders | List folders |\n| POST | /file-manager/folders | Add folder |\n| GET | /file-manager/folders/{folder_id} | Get folder |\n| PATCH | /file-manager/folders/{folder_id} | Update folder |\n| DELETE | /file-manager/folders/{folder_id} | Delete folder |\n| GET | /file-manager/folders/{folder_id}/files | List stored files |\n\n### Lists\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /lists | Get lists info |\n| POST | /lists | Add list |\n| GET | /lists/{list_id} | Get list info |\n| PATCH | /lists/{list_id} | Update lists |\n| DELETE | /lists/{list_id} | Delete list |\n| POST | /lists/{list_id} | Batch subscribe or unsubscribe |\n| GET | /lists/{list_id}/abuse-reports | List abuse reports |\n| GET | /lists/{list_id}/abuse-reports/{report_id} | Get abuse report |\n| GET | /lists/{list_id}/activity | List recent activity |\n| GET | /lists/{list_id}/clients | List top email clients |\n| GET | /lists/{list_id}/growth-history | List growth history data |\n| GET | /lists/{list_id}/growth-history/{month} | Get growth history by month |\n| GET | /lists/{list_id}/interest-categories | List interest categories |\n| POST | /lists/{list_id}/interest-categories | Add interest category |\n| GET | /lists/{list_id}/interest-categories/{interest_category_id} | Get interest category info |\n| PATCH | /lists/{list_id}/interest-categories/{interest_category_id} | Update interest category |\n| DELETE | /lists/{list_id}/interest-categories/{interest_category_id} | Delete interest category |\n| GET | /lists/{list_id}/interest-categories/{interest_category_id}/interests | List interests in category |\n| POST | /lists/{list_id}/interest-categories/{interest_category_id}/interests | Add interest in category |\n| GET | /lists/{list_id}/interest-categories/{interest_category_id}/interests/{interest_id} | Get interest in category |\n| PATCH | /lists/{list_id}/interest-categories/{interest_category_id}/interests/{interest_id} | Update interest in category |\n| DELETE | /lists/{list_id}/interest-categories/{interest_category_id}/interests/{interest_id} | Delete interest in category |\n| GET | /lists/{list_id}/segments | List segments |\n| POST | /lists/{list_id}/segments | Add segment |\n| GET | /lists/{list_id}/segments/{segment_id} | Get segment info |\n| DELETE | /lists/{list_id}/segments/{segment_id} | Delete segment |\n| PATCH | /lists/{list_id}/segments/{segment_id} | Update segment |\n| POST | /lists/{list_id}/segments/{segment_id} | Batch add or remove members |\n| GET | /lists/{list_id}/segments/{segment_id}/members | List members in segment |\n| POST | /lists/{list_id}/segments/{segment_id}/members | Add member to segment |\n| DELETE | /lists/{list_id}/segments/{segment_id}/members/{subscriber_hash} | Remove list member from segment |\n| GET | /lists/{list_id}/tag-search | Search for tags on a list by name. |\n| GET | /lists/{list_id}/members | List members info |\n| POST | /lists/{list_id}/members | Add member to list |\n| GET | /lists/{list_id}/members/{subscriber_hash} | Get member info |\n| PUT | /lists/{list_id}/members/{subscriber_hash} | Add or update list member |\n| PATCH | /lists/{list_id}/members/{subscriber_hash} | Update list member |\n| DELETE | /lists/{list_id}/members/{subscriber_hash} | Archive list member |\n| GET | /lists/{list_id}/members/{subscriber_hash}/activity | View recent activity 50 |\n| GET | /lists/{list_id}/members/{subscriber_hash}/activity-feed | View recent activity |\n| GET | /lists/{list_id}/members/{subscriber_hash}/tags | List member tags |\n| POST | /lists/{list_id}/members/{subscriber_hash}/tags | Add or remove member tags |\n| GET | /lists/{list_id}/members/{subscriber_hash}/events | List member events |\n| POST | /lists/{list_id}/members/{subscriber_hash}/events | Add event |\n| GET | /lists/{list_id}/members/{subscriber_hash}/goals | List member goal events |\n| GET | /lists/{list_id}/members/{subscriber_hash}/notes | List recent member notes |\n| POST | /lists/{list_id}/members/{subscriber_hash}/notes | Add member note |\n| GET | /lists/{list_id}/members/{subscriber_hash}/notes/{note_id} | Get member note |\n| PATCH | /lists/{list_id}/members/{subscriber_hash}/notes/{note_id} | Update note |\n| DELETE | /lists/{list_id}/members/{subscriber_hash}/notes/{note_id} | Delete note |\n| POST | /lists/{list_id}/members/{subscriber_hash}/actions/delete-permanent | Delete list member |\n| GET | /lists/{list_id}/merge-fields | List merge fields |\n| POST | /lists/{list_id}/merge-fields | Add merge field |\n| GET | /lists/{list_id}/merge-fields/{merge_id} | Get merge field |\n| PATCH | /lists/{list_id}/merge-fields/{merge_id} | Update merge field |\n| DELETE | /lists/{list_id}/merge-fields/{merge_id} | Delete merge field |\n| GET | /lists/{list_id}/webhooks | List webhooks |\n| POST | /lists/{list_id}/webhooks | Add webhook |\n| GET | /lists/{list_id}/webhooks/{webhook_id} | Get webhook info |\n| DELETE | /lists/{list_id}/webhooks/{webhook_id} | Delete webhook |\n| PATCH | /lists/{list_id}/webhooks/{webhook_id} | Update webhook |\n| GET | /lists/{list_id}/signup-forms | List signup forms |\n| POST | /lists/{list_id}/signup-forms | Customize signup form |\n| GET | /lists/{list_id}/locations | List locations |\n| GET | /lists/{list_id}/surveys | Get information about all surveys for a list |\n| GET | /lists/{list_id}/surveys/{survey_id} | Get survey |\n| POST | /lists/{list_id}/surveys/{survey_id}/actions/publish | Publish a Survey |\n| POST | /lists/{list_id}/surveys/{survey_id}/actions/unpublish | Unpublish a Survey |\n| POST | /lists/{list_id}/surveys/{survey_id}/actions/create-email | Create a Survey Campaign |\n\n### Landing-pages\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /landing-pages | List landing pages |\n| POST | /landing-pages | Add landing page |\n| GET | /landing-pages/{page_id} | Get landing page info |\n| PATCH | /landing-pages/{page_id} | Update landing page |\n| DELETE | /landing-pages/{page_id} | Delete landing page |\n| POST | /landing-pages/{page_id}/actions/publish | Publish landing page |\n| POST | /landing-pages/{page_id}/actions/unpublish | Unpublish landing page |\n| GET | /landing-pages/{page_id}/content | Get landing page content |\n\n### Reports\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /reports | List campaign reports |\n| GET | /reports/{campaign_id} | Get campaign report |\n| GET | /reports/{campaign_id}/abuse-reports | List abuse reports |\n| GET | /reports/{campaign_id}/abuse-reports/{report_id} | Get abuse report |\n| GET | /reports/{campaign_id}/advice | List campaign feedback |\n| GET | /reports/{campaign_id}/click-details | List campaign details |\n| GET | /reports/{campaign_id}/click-details/{link_id} | Get campaign link details |\n| GET | /reports/{campaign_id}/click-details/{link_id}/members | List clicked link subscribers |\n| GET | /reports/{campaign_id}/click-details/{link_id}/members/{subscriber_hash} | Get clicked link subscriber |\n| GET | /reports/{campaign_id}/open-details | List campaign open details |\n| GET | /reports/{campaign_id}/open-details/{subscriber_hash} | Get opened campaign subscriber |\n| GET | /reports/{campaign_id}/domain-performance | List domain performance stats |\n| GET | /reports/{campaign_id}/eepurl | List EepURL activity |\n| GET | /reports/{campaign_id}/email-activity | List email activity |\n| GET | /reports/{campaign_id}/email-activity/{subscriber_hash} | Get subscriber email activity |\n| GET | /reports/{campaign_id}/locations | List top open activities |\n| GET | /reports/{campaign_id}/sent-to | List campaign recipients |\n| GET | /reports/{campaign_id}/sent-to/{subscriber_hash} | Get campaign recipient info |\n| GET | /reports/{campaign_id}/sub-reports | List child campaign reports |\n| GET | /reports/{campaign_id}/unsubscribed | List unsubscribed members |\n| GET | /reports/{campaign_id}/unsubscribed/{subscriber_hash} | Get unsubscribed member |\n| GET | /reports/{campaign_id}/ecommerce-product-activity | List campaign product activity |\n\n### Templates\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /templates | List templates |\n| POST | /templates | Add template |\n| GET | /templates/{template_id} | Get template info |\n| PATCH | /templates/{template_id} | Update template |\n| DELETE | /templates/{template_id} | Delete template |\n| GET | /templates/{template_id}/default-content | View default content |\n\n### Ecommerce\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /ecommerce/orders | List account orders |\n| GET | /ecommerce/stores | List stores |\n| POST | /ecommerce/stores | Add store |\n| GET | /ecommerce/stores/{store_id} | Get store info |\n| PATCH | /ecommerce/stores/{store_id} | Update store |\n| DELETE | /ecommerce/stores/{store_id} | Delete store |\n| GET | /ecommerce/stores/{store_id}/carts | List carts |\n| POST | /ecommerce/stores/{store_id}/carts | Add cart |\n| GET | /ecommerce/stores/{store_id}/carts/{cart_id} | Get cart info |\n| PATCH | /ecommerce/stores/{store_id}/carts/{cart_id} | Update cart |\n| DELETE | /ecommerce/stores/{store_id}/carts/{cart_id} | Delete cart |\n| GET | /ecommerce/stores/{store_id}/carts/{cart_id}/lines | List cart line items |\n| POST | /ecommerce/stores/{store_id}/carts/{cart_id}/lines | Add cart line item |\n| GET | /ecommerce/stores/{store_id}/carts/{cart_id}/lines/{line_id} | Get cart line item |\n| PATCH | /ecommerce/stores/{store_id}/carts/{cart_id}/lines/{line_id} | Update cart line item |\n| DELETE | /ecommerce/stores/{store_id}/carts/{cart_id}/lines/{line_id} | Delete cart line item |\n| GET | /ecommerce/stores/{store_id}/customers | List customers |\n| POST | /ecommerce/stores/{store_id}/customers | Add customer |\n| GET | /ecommerce/stores/{store_id}/customers/{customer_id} | Get customer info |\n| PUT | /ecommerce/stores/{store_id}/customers/{customer_id} | Add or update customer |\n| PATCH | /ecommerce/stores/{store_id}/customers/{customer_id} | Update customer |\n| DELETE | /ecommerce/stores/{store_id}/customers/{customer_id} | Delete customer |\n| GET | /ecommerce/stores/{store_id}/promo-rules | List promo rules |\n| POST | /ecommerce/stores/{store_id}/promo-rules | Add promo rule |\n| GET | /ecommerce/stores/{store_id}/promo-rules/{promo_rule_id} | Get promo rule |\n| PATCH | /ecommerce/stores/{store_id}/promo-rules/{promo_rule_id} | Update promo rule |\n| DELETE | /ecommerce/stores/{store_id}/promo-rules/{promo_rule_id} | Delete promo rule |\n| GET | /ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}/promo-codes | List promo codes |\n| POST | /ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}/promo-codes | Add promo code |\n| GET | /ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}/promo-codes/{promo_code_id} | Get promo code |\n| PATCH | /ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}/promo-codes/{promo_code_id} | Update promo code |\n| DELETE | /ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}/promo-codes/{promo_code_id} | Delete promo code |\n| GET | /ecommerce/stores/{store_id}/orders | List orders |\n| POST | /ecommerce/stores/{store_id}/orders | Add order |\n| GET | /ecommerce/stores/{store_id}/orders/{order_id} | Get order info |\n| PUT | /ecommerce/stores/{store_id}/orders/{order_id} | Add or update order |\n| PATCH | /ecommerce/stores/{store_id}/orders/{order_id} | Update order |\n| DELETE | /ecommerce/stores/{store_id}/orders/{order_id} | Delete order |\n| GET | /ecommerce/stores/{store_id}/orders/{order_id}/lines | List order line items |\n| POST | /ecommerce/stores/{store_id}/orders/{order_id}/lines | Add order line item |\n| GET | /ecommerce/stores/{store_id}/orders/{order_id}/lines/{line_id} | Get order line item |\n| PATCH | /ecommerce/stores/{store_id}/orders/{order_id}/lines/{line_id} | Update order line item |\n| DELETE | /ecommerce/stores/{store_id}/orders/{order_id}/lines/{line_id} | Delete order line item |\n| GET | /ecommerce/stores/{store_id}/products | List product |\n| POST | /ecommerce/stores/{store_id}/products | Add product |\n| GET | /ecommerce/stores/{store_id}/products/{product_id} | Get product info |\n| PATCH | /ecommerce/stores/{store_id}/products/{product_id} | Update product |\n| PUT | /ecommerce/stores/{store_id}/products/{product_id} | Create or update product |\n| DELETE | /ecommerce/stores/{store_id}/products/{product_id} | Delete product |\n| GET | /ecommerce/stores/{store_id}/products/{product_id}/variants | List product variants |\n| POST | /ecommerce/stores/{store_id}/products/{product_id}/variants | Add product variant |\n| GET | /ecommerce/stores/{store_id}/products/{product_id}/variants/{variant_id} | Get product variant info |\n| PUT | /ecommerce/stores/{store_id}/products/{product_id}/variants/{variant_id} | Add or update product variant |\n| PATCH | /ecommerce/stores/{store_id}/products/{product_id}/variants/{variant_id} | Update product variant |\n| DELETE | /ecommerce/stores/{store_id}/products/{product_id}/variants/{variant_id} | Delete product variant |\n| GET | /ecommerce/stores/{store_id}/products/{product_id}/images | List product images |\n| POST | /ecommerce/stores/{store_id}/products/{product_id}/images | Add product image |\n| GET | /ecommerce/stores/{store_id}/products/{product_id}/images/{image_id} | Get product image info |\n| PATCH | /ecommerce/stores/{store_id}/products/{product_id}/images/{image_id} | Update product image |\n| DELETE | /ecommerce/stores/{store_id}/products/{product_id}/images/{image_id} | Delete product image |\n\n### Search-campaigns\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /search-campaigns | Search campaigns |\n\n### Search-members\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /search-members | Search members |\n\n### Ping\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /ping | Ping |\n\n### Facebook-ads\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /facebook-ads | List facebook ads |\n| GET | /facebook-ads/{outreach_id} | Get facebook ad info |\n\n### Reporting\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /reporting/facebook-ads | List facebook ads reports |\n| GET | /reporting/facebook-ads/{outreach_id} | Get facebook ad report |\n| GET | /reporting/facebook-ads/{outreach_id}/ecommerce-product-activity | List facebook ecommerce report |\n| GET | /reporting/landing-pages/{outreach_id} | Get landing page report |\n| GET | /reporting/landing-pages | List landing pages reports |\n| GET | /reporting/surveys | List survey reports |\n| GET | /reporting/surveys/{survey_id} | Get survey report |\n| GET | /reporting/surveys/{survey_id}/questions | List survey question reports |\n| GET | /reporting/surveys/{survey_id}/questions/{question_id} | Get survey question report |\n| GET | /reporting/surveys/{survey_id}/questions/{question_id}/answers | List answers for question |\n| GET | /reporting/surveys/{survey_id}/responses | List survey responses |\n| GET | /reporting/surveys/{survey_id}/responses/{response_id} | Get survey response |\n\n### Verified-domains\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /verified-domains/{domain_name} | Get domain info |\n| DELETE | /verified-domains/{domain_name} | Delete domain |\n| POST | /verified-domains/{domain_name}/actions/verify | Verify domain |\n| GET | /verified-domains | List sending domains |\n| POST | /verified-domains | Add domain to account |\n\n## Common Questions\nMatch user requests to endpoints in references/api-spec.lap. Key patterns:\n- \"List all resource?\" -> GET /\n- \"List all chimp-chatter?\" -> GET /activity-feed/chimp-chatter\n- \"List all account-exports?\" -> GET /account-exports\n- \"Create a account-export?\" -> POST /account-exports\n- \"Get account-export details?\" -> GET /account-exports/{export_id}\n- \"List all audiences?\" -> GET /audiences\n- \"Get audience details?\" -> GET /audiences/{audience_id}\n- \"List all contacts?\" -> GET /audiences/{audience_id}/contacts\n- \"Create a contact?\" -> POST /audiences/{audience_id}/contacts\n- \"Get contact details?\" -> GET /audiences/{audience_id}/contacts/{contact_id}\n- \"Partially update a contact?\" -> PATCH /audiences/{audience_id}/contacts/{contact_id}\n- \"Create a archive?\" -> POST /audiences/{audience_id}/contacts/{contact_id}/actions/archive\n- \"Create a forget?\" -> POST /audiences/{audience_id}/contacts/{contact_id}/actions/forget\n- \"List all authorized-apps?\" -> GET /authorized-apps\n- \"Get authorized-app details?\" -> GET /authorized-apps/{app_id}\n- \"List all automations?\" -> GET /automations\n- \"Create a automation?\" -> POST /automations\n- \"Get automation details?\" -> GET /automations/{workflow_id}\n- \"Create a pause-all-email?\" -> POST /automations/{workflow_id}/actions/pause-all-emails\n- \"Create a start-all-email?\" -> POST /automations/{workflow_id}/actions/start-all-emails\n- \"List all emails?\" -> GET /automations/{workflow_id}/emails\n- \"Get email details?\" -> GET /automations/{workflow_id}/emails/{workflow_email_id}\n- \"Delete a email?\" -> DELETE /automations/{workflow_id}/emails/{workflow_email_id}\n- \"Partially update a email?\" -> PATCH /automations/{workflow_id}/emails/{workflow_email_id}\n- \"List all queue?\" -> GET /automations/{workflow_id}/emails/{workflow_email_id}/queue\n- \"Create a queue?\" -> POST /automations/{workflow_id}/emails/{workflow_email_id}/queue\n- \"Get queue details?\" -> GET /automations/{workflow_id}/emails/{workflow_email_id}/queue/{subscriber_hash}\n- \"Create a pause?\" -> POST /automations/{workflow_id}/emails/{workflow_email_id}/actions/pause\n- \"Create a start?\" -> POST /automations/{workflow_id}/emails/{workflow_email_id}/actions/start\n- \"List all removed-subscribers?\" -> GET /automations/{workflow_id}/removed-subscribers\n- \"Create a removed-subscriber?\" -> POST /automations/{workflow_id}/removed-subscribers\n- \"Get removed-subscriber details?\" -> GET /automations/{workflow_id}/removed-subscribers/{subscriber_hash}\n- \"List all batches?\" -> GET /batches\n- \"Create a batche?\" -> POST /batches\n- \"Get batche details?\" -> GET /batches/{batch_id}\n- \"Delete a batche?\" -> DELETE /batches/{batch_id}\n- \"List all batch-webhooks?\" -> GET /batch-webhooks\n- \"Create a batch-webhook?\" -> POST /batch-webhooks\n- \"Get batch-webhook details?\" -> GET /batch-webhooks/{batch_webhook_id}\n- \"Partially update a batch-webhook?\" -> PATCH /batch-webhooks/{batch_webhook_id}\n- \"Delete a batch-webhook?\" -> DELETE /batch-webhooks/{batch_webhook_id}\n- \"List all template-folders?\" -> GET /template-folders\n- \"Create a template-folder?\" -> POST /template-folders\n- \"Get template-folder details?\" -> GET /template-folders/{folder_id}\n- \"Partially update a template-folder?\" -> PATCH /template-folders/{folder_id}\n- \"Delete a template-folder?\" -> DELETE /template-folders/{folder_id}\n- \"List all campaign-folders?\" -> GET /campaign-folders\n- \"Create a campaign-folder?\" -> POST /campaign-folders\n- \"Get campaign-folder details?\" -> GET /campaign-folders/{folder_id}\n- \"Partially update a campaign-folder?\" -> PATCH /campaign-folders/{folder_id}\n- \"Delete a campaign-folder?\" -> DELETE /campaign-folders/{folder_id}\n- \"List all campaigns?\" -> GET /campaigns\n- \"Create a campaign?\" -> POST /campaigns\n- \"Get campaign details?\" -> GET /campaigns/{campaign_id}\n- \"Partially update a campaign?\" -> PATCH /campaigns/{campaign_id}\n- \"Delete a campaign?\" -> DELETE /campaigns/{campaign_id}\n- \"Create a cancel-send?\" -> POST /campaigns/{campaign_id}/actions/cancel-send\n- \"Create a replicate?\" -> POST /campaigns/{campaign_id}/actions/replicate\n- \"Create a send?\" -> POST /campaigns/{campaign_id}/actions/send\n- \"Create a schedule?\" -> POST /campaigns/{campaign_id}/actions/schedule\n- \"Create a unschedule?\" -> POST /campaigns/{campaign_id}/actions/unschedule\n- \"Create a test?\" -> POST /campaigns/{campaign_id}/actions/test\n- \"Create a resume?\" -> POST /campaigns/{campaign_id}/actions/resume\n- \"Create a create-resend?\" -> POST /campaigns/{campaign_id}/actions/create-resend\n- \"List all content?\" -> GET /campaigns/{campaign_id}/content\n- \"List all feedback?\" -> GET /campaigns/{campaign_id}/feedback\n- \"Create a feedback?\" -> POST /campaigns/{campaign_id}/feedback\n- \"Get feedback details?\" -> GET /campaigns/{campaign_id}/feedback/{feedback_id}\n- \"Partially update a feedback?\" -> PATCH /campaigns/{campaign_id}/feedback/{feedback_id}\n- \"Delete a feedback?\" -> DELETE /campaigns/{campaign_id}/feedback/{feedback_id}\n- \"List all send-checklist?\" -> GET /campaigns/{campaign_id}/send-checklist\n- \"List all connected-sites?\" -> GET /connected-sites\n- \"Create a connected-site?\" -> POST /connected-sites\n- \"Get connected-site details?\" -> GET /connected-sites/{connected_site_id}\n- \"Delete a connected-site?\" -> DELETE /connected-sites/{connected_site_id}\n- \"Create a verify-script-installation?\" -> POST /connected-sites/{connected_site_id}/actions/verify-script-installation\n- \"List all conversations?\" -> GET /conversations\n- \"Get conversation details?\" -> GET /conversations/{conversation_id}\n- \"List all messages?\" -> GET /conversations/{conversation_id}/messages\n- \"Get message details?\" -> GET /conversations/{conversation_id}/messages/{message_id}\n- \"Create a trigger?\" -> POST /customer-journeys/journeys/{journey_id}/steps/{step_id}/actions/trigger\n- \"List all files?\" -> GET /file-manager/files\n- \"Create a file?\" -> POST /file-manager/files\n- \"Get file details?\" -> GET /file-manager/files/{file_id}\n- \"Partially update a file?\" -> PATCH /file-manager/files/{file_id}\n- \"Delete a file?\" -> DELETE /file-manager/files/{file_id}\n- \"List all folders?\" -> GET /file-manager/folders\n- \"Create a folder?\" -> POST /file-manager/folders\n- \"Get folder details?\" -> GET /file-manager/folders/{folder_id}\n- \"Partially update a folder?\" -> PATCH /file-manager/folders/{folder_id}\n- \"Delete a folder?\" -> DELETE /file-manager/folders/{folder_id}\n- \"List all lists?\" -> GET /lists\n- \"Create a list?\" -> POST /lists\n- \"Get list details?\" -> GET /lists/{list_id}\n- \"Partially update a list?\" -> PATCH /lists/{list_id}\n- \"Delete a list?\" -> DELETE /lists/{list_id}\n- \"List all abuse-reports?\" -> GET /lists/{list_id}/abuse-reports\n- \"Get abuse-report details?\" -> GET /lists/{list_id}/abuse-reports/{report_id}\n- \"List all activity?\" -> GET /lists/{list_id}/activity\n- \"List all clients?\" -> GET /lists/{list_id}/clients\n- \"List all growth-history?\" -> GET /lists/{list_id}/growth-history\n- \"Get growth-history details?\" -> GET /lists/{list_id}/growth-history/{month}\n- \"List all interest-categories?\" -> GET /lists/{list_id}/interest-categories\n- \"Create a interest-category?\" -> POST /lists/{list_id}/interest-categories\n- \"Get interest-category details?\" -> GET /lists/{list_id}/interest-categories/{interest_category_id}\n- \"Partially update a interest-category?\" -> PATCH /lists/{list_id}/interest-categories/{interest_category_id}\n- \"Delete a interest-category?\" -> DELETE /lists/{list_id}/interest-categories/{interest_category_id}\n- \"List all interests?\" -> GET /lists/{list_id}/interest-categories/{interest_category_id}/interests\n- \"Create a interest?\" -> POST /lists/{list_id}/interest-categories/{interest_category_id}/interests\n- \"Get interest details?\" -> GET /lists/{list_id}/interest-categories/{interest_category_id}/interests/{interest_id}\n- \"Partially update a interest?\" -> PATCH /lists/{list_id}/interest-categories/{interest_category_id}/interests/{interest_id}\n- \"Delete a interest?\" -> DELETE /lists/{list_id}/interest-categories/{interest_category_id}/interests/{interest_id}\n- \"List all segments?\" -> GET /lists/{list_id}/segments\n- \"Create a segment?\" -> POST /lists/{list_id}/segments\n- \"Get segment details?\" -> GET /lists/{list_id}/segments/{segment_id}\n- \"Delete a segment?\" -> DELETE /lists/{list_id}/segments/{segment_id}\n- \"Partially update a segment?\" -> PATCH /lists/{list_id}/segments/{segment_id}\n- \"List all members?\" -> GET /lists/{list_id}/segments/{segment_id}/members\n- \"Create a member?\" -> POST /lists/{list_id}/segments/{segment_id}/members\n- \"Delete a member?\" -> DELETE /lists/{list_id}/segments/{segment_id}/members/{subscriber_hash}\n- \"List all tag-search?\" -> GET /lists/{list_id}/tag-search\n- \"Get member details?\" -> GET /lists/{list_id}/members/{subscriber_hash}\n- \"Update a member?\" -> PUT /lists/{list_id}/members/{subscriber_hash}\n- \"Partially update a member?\" -> PATCH /lists/{list_id}/members/{subscriber_hash}\n- \"List all activity-feed?\" -> GET /lists/{list_id}/members/{subscriber_hash}/activity-feed\n- \"List all tags?\" -> GET /lists/{list_id}/members/{subscriber_hash}/tags\n- \"Create a tag?\" -> POST /lists/{list_id}/members/{subscriber_hash}/tags\n- \"List all events?\" -> GET /lists/{list_id}/members/{subscriber_hash}/events\n- \"Create a event?\" -> POST /lists/{list_id}/members/{subscriber_hash}/events\n- \"List all goals?\" -> GET /lists/{list_id}/members/{subscriber_hash}/goals\n- \"List all notes?\" -> GET /lists/{list_id}/members/{subscriber_hash}/notes\n- \"Create a note?\" -> POST /lists/{list_id}/members/{subscriber_hash}/notes\n- \"Get note details?\" -> GET /lists/{list_id}/members/{subscriber_hash}/notes/{note_id}\n- \"Partially update a note?\" -> PATCH /lists/{list_id}/members/{subscriber_hash}/notes/{note_id}\n- \"Delete a note?\" -> DELETE /lists/{list_id}/members/{subscriber_hash}/notes/{note_id}\n- \"Create a delete-permanent?\" -> POST /lists/{list_id}/members/{subscriber_hash}/actions/delete-permanent\n- \"List all merge-fields?\" -> GET /lists/{list_id}/merge-fields\n- \"Create a merge-field?\" -> POST /lists/{list_id}/merge-fields\n- \"Get merge-field details?\" -> GET /lists/{list_id}/merge-fields/{merge_id}\n- \"Partially update a merge-field?\" -> PATCH /lists/{list_id}/merge-fields/{merge_id}\n- \"Delete a merge-field?\" -> DELETE /lists/{list_id}/merge-fields/{merge_id}\n- \"List all webhooks?\" -> GET /lists/{list_id}/webhooks\n- \"Create a webhook?\" -> POST /lists/{list_id}/webhooks\n- \"Get webhook details?\" -> GET /lists/{list_id}/webhooks/{webhook_id}\n- \"Delete a webhook?\" -> DELETE /lists/{list_id}/webhooks/{webhook_id}\n- \"Partially update a webhook?\" -> PATCH /lists/{list_id}/webhooks/{webhook_id}\n- \"List all signup-forms?\" -> GET /lists/{list_id}/signup-forms\n- \"Create a signup-form?\" -> POST /lists/{list_id}/signup-forms\n- \"List all locations?\" -> GET /lists/{list_id}/locations\n- \"List all surveys?\" -> GET /lists/{list_id}/surveys\n- \"Get survey details?\" -> GET /lists/{list_id}/surveys/{survey_id}\n- \"Create a publish?\" -> POST /lists/{list_id}/surveys/{survey_id}/actions/publish\n- \"Create a unpublish?\" -> POST /lists/{list_id}/surveys/{survey_id}/actions/unpublish\n- \"Create a create-email?\" -> POST /lists/{list_id}/surveys/{survey_id}/actions/create-email\n- \"List all landing-pages?\" -> GET /landing-pages\n- \"Create a landing-page?\" -> POST /landing-pages\n- \"Get landing-page details?\" -> GET /landing-pages/{page_id}\n- \"Partially update a landing-page?\" -> PATCH /landing-pages/{page_id}\n- \"Delete a landing-page?\" -> DELETE /landing-pages/{page_id}\n- \"List all reports?\" -> GET /reports\n- \"Get report details?\" -> GET /reports/{campaign_id}\n- \"List all advice?\" -> GET /reports/{campaign_id}/advice\n- \"List all click-details?\" -> GET /reports/{campaign_id}/click-details\n- \"Get click-detail details?\" -> GET /reports/{campaign_id}/click-details/{link_id}\n- \"List all open-details?\" -> GET /reports/{campaign_id}/open-details\n- \"Get open-detail details?\" -> GET /reports/{campaign_id}/open-details/{subscriber_hash}\n- \"List all domain-performance?\" -> GET /reports/{campaign_id}/domain-performance\n- \"List all eepurl?\" -> GET /reports/{campaign_id}/eepurl\n- \"List all email-activity?\" -> GET /reports/{campaign_id}/email-activity\n- \"Get email-activity details?\" -> GET /reports/{campaign_id}/email-activity/{subscriber_hash}\n- \"List all sent-to?\" -> GET /reports/{campaign_id}/sent-to\n- \"Get sent-to details?\" -> GET /reports/{campaign_id}/sent-to/{subscriber_hash}\n- \"List all sub-reports?\" -> GET /reports/{campaign_id}/sub-reports\n- \"List all unsubscribed?\" -> GET /reports/{campaign_id}/unsubscribed\n- \"Get unsubscribed details?\" -> GET /reports/{campaign_id}/unsubscribed/{subscriber_hash}\n- \"List all ecommerce-product-activity?\" -> GET /reports/{campaign_id}/ecommerce-product-activity\n- \"List all templates?\" -> GET /templates\n- \"Create a template?\" -> POST /templates\n- \"Get template details?\" -> GET /templates/{template_id}\n- \"Partially update a template?\" -> PATCH /templates/{template_id}\n- \"Delete a template?\" -> DELETE /templates/{template_id}\n- \"List all default-content?\" -> GET /templates/{template_id}/default-content\n- \"List all orders?\" -> GET /ecommerce/orders\n- \"List all stores?\" -> GET /ecommerce/stores\n- \"Create a store?\" -> POST /ecommerce/stores\n- \"Get store details?\" -> GET /ecommerce/stores/{store_id}\n- \"Partially update a store?\" -> PATCH /ecommerce/stores/{store_id}\n- \"Delete a store?\" -> DELETE /ecommerce/stores/{store_id}\n- \"List all carts?\" -> GET /ecommerce/stores/{store_id}/carts\n- \"Create a cart?\" -> POST /ecommerce/stores/{store_id}/carts\n- \"Get cart details?\" -> GET /ecommerce/stores/{store_id}/carts/{cart_id}\n- \"Partially update a cart?\" -> PATCH /ecommerce/stores/{store_id}/carts/{cart_id}\n- \"Delete a cart?\" -> DELETE /ecommerce/stores/{store_id}/carts/{cart_id}\n- \"List all lines?\" -> GET /ecommerce/stores/{store_id}/carts/{cart_id}/lines\n- \"Create a line?\" -> POST /ecommerce/stores/{store_id}/carts/{cart_id}/lines\n- \"Get line details?\" -> GET /ecommerce/stores/{store_id}/carts/{cart_id}/lines/{line_id}\n- \"Partially update a line?\" -> PATCH /ecommerce/stores/{store_id}/carts/{cart_id}/lines/{line_id}\n- \"Delete a line?\" -> DELETE /ecommerce/stores/{store_id}/carts/{cart_id}/lines/{line_id}\n- \"List all customers?\" -> GET /ecommerce/stores/{store_id}/customers\n- \"Create a customer?\" -> POST /ecommerce/stores/{store_id}/customers\n- \"Get customer details?\" -> GET /ecommerce/stores/{store_id}/customers/{customer_id}\n- \"Update a customer?\" -> PUT /ecommerce/stores/{store_id}/customers/{customer_id}\n- \"Partially update a customer?\" -> PATCH /ecommerce/stores/{store_id}/customers/{customer_id}\n- \"Delete a customer?\" -> DELETE /ecommerce/stores/{store_id}/customers/{customer_id}\n- \"List all promo-rules?\" -> GET /ecommerce/stores/{store_id}/promo-rules\n- \"Create a promo-rule?\" -> POST /ecommerce/stores/{store_id}/promo-rules\n- \"Get promo-rule details?\" -> GET /ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}\n- \"Partially update a promo-rule?\" -> PATCH /ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}\n- \"Delete a promo-rule?\" -> DELETE /ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}\n- \"List all promo-codes?\" -> GET /ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}/promo-codes\n- \"Create a promo-code?\" -> POST /ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}/promo-codes\n- \"Get promo-code details?\" -> GET /ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}/promo-codes/{promo_code_id}\n- \"Partially update a promo-code?\" -> PATCH /ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}/promo-codes/{promo_code_id}\n- \"Delete a promo-code?\" -> DELETE /ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}/promo-codes/{promo_code_id}\n- \"Create a order?\" -> POST /ecommerce/stores/{store_id}/orders\n- \"Get order details?\" -> GET /ecommerce/stores/{store_id}/orders/{order_id}\n- \"Update a order?\" -> PUT /ecommerce/stores/{store_id}/orders/{order_id}\n- \"Partially update a order?\" -> PATCH /ecommerce/stores/{store_id}/orders/{order_id}\n- \"Delete a order?\" -> DELETE /ecommerce/stores/{store_id}/orders/{order_id}\n- \"List all products?\" -> GET /ecommerce/stores/{store_id}/products\n- \"Create a product?\" -> POST /ecommerce/stores/{store_id}/products\n- \"Get product details?\" -> GET /ecommerce/stores/{store_id}/products/{product_id}\n- \"Partially update a product?\" -> PATCH /ecommerce/stores/{store_id}/products/{product_id}\n- \"Update a product?\" -> PUT /ecommerce/stores/{store_id}/products/{product_id}\n- \"Delete a product?\" -> DELETE /ecommerce/stores/{store_id}/products/{product_id}\n- \"List all variants?\" -> GET /ecommerce/stores/{store_id}/products/{product_id}/variants\n- \"Create a variant?\" -> POST /ecommerce/stores/{store_id}/products/{product_id}/variants\n- \"Get variant details?\" -> GET /ecommerce/stores/{store_id}/products/{product_id}/variants/{variant_id}\n- \"Update a variant?\" -> PUT /ecommerce/stores/{store_id}/products/{product_id}/variants/{variant_id}\n- \"Partially update a variant?\" -> PATCH /ecommerce/stores/{store_id}/products/{product_id}/variants/{variant_id}\n- \"Delete a variant?\" -> DELETE /ecommerce/stores/{store_id}/products/{product_id}/variants/{variant_id}\n- \"List all images?\" -> GET /ecommerce/stores/{store_id}/products/{product_id}/images\n- \"Create a image?\" -> POST /ecommerce/stores/{store_id}/products/{product_id}/images\n- \"Get image details?\" -> GET /ecommerce/stores/{store_id}/products/{product_id}/images/{image_id}\n- \"Partially update a image?\" -> PATCH /ecommerce/stores/{store_id}/products/{product_id}/images/{image_id}\n- \"Delete a image?\" -> DELETE /ecommerce/stores/{store_id}/products/{product_id}/images/{image_id}\n- \"Search search-campaigns?\" -> GET /search-campaigns\n- \"Search search-members?\" -> GET /search-members\n- \"List all ping?\" -> GET /ping\n- \"List all facebook-ads?\" -> GET /facebook-ads\n- \"Get facebook-ad details?\" -> GET /facebook-ads/{outreach_id}\n- \"List all questions?\" -> GET /reporting/surveys/{survey_id}/questions\n- \"Get question details?\" -> GET /reporting/surveys/{survey_id}/questions/{question_id}\n- \"List all answers?\" -> GET /reporting/surveys/{survey_id}/questions/{question_id}/answers\n- \"List all responses?\" -> GET /reporting/surveys/{survey_id}/responses\n- \"Get response details?\" -> GET /reporting/surveys/{survey_id}/responses/{response_id}\n- \"Get verified-domain details?\" -> GET /verified-domains/{domain_name}\n- \"Delete a verified-domain?\" -> DELETE /verified-domains/{domain_name}\n- \"Create a verify?\" -> POST /verified-domains/{domain_name}/actions/verify\n- \"List all verified-domains?\" -> GET /verified-domains\n- \"Create a verified-domain?\" -> POST /verified-domains\n- \"How to authenticate?\" -> See Auth section above\n\n## Response Tips\n- Check response schemas in references/api-spec.lap for field details\n- Paginated endpoints accept limit/offset or cursor parameters\n- Create/update endpoints return the modified resource on success\n\n## References\n- Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas\n\n> Generated from the official API spec by [LAP](https://lap.sh)\n","references/api-spec.lap":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api Mailchimp Marketing API\n@base https://server.api.mailchimp.com/3.0\n@version 3.0.91\n@auth basic\n@endpoints 282\n@hint download_for_search\n@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)\n\n@group root\n@endpoint GET /\n@desc List api root resources\n@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.}\n@returns(200)\n\n@endgroup\n\n@group activity-feed\n@endpoint GET /activity-feed/chimp-chatter\n@desc Get latest chimp chatter\n@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.}\n@returns(200) ChimpChatter Collection\n\n@endgroup\n\n@group account-exports\n@endpoint GET /account-exports\n@desc List account exports\n@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.}\n@returns(200)\n\n@endpoint POST /account-exports\n@desc Add export\n@required {body: map}\n@returns(200)\n\n@endpoint GET /account-exports/{export_id}\n@desc Get account export info\n@required {export_id: any # The unique id for the account export.}\n@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.}\n@returns(200)\n\n@endgroup\n\n@group audiences\n@endpoint GET /audiences\n@desc Get a list of audiences\n@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.}\n@returns(200)\n\n@endpoint GET /audiences/{audience_id}\n@desc Get audience info\n@required {audience_id: any # The unique ID for the audience.}\n@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.}\n@returns(200)\n\n@endpoint GET /audiences/{audience_id}/contacts\n@desc Get Contacts\n@required {audience_id: any # The unique ID for the audience.}\n@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.}\n@returns(200)\n\n@endpoint POST /audiences/{audience_id}/contacts\n@desc Add Contact\n@required {body: map, audience_id: any # The unique ID for the audience.}\n@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.}\n@returns(200)\n\n@endpoint GET /audiences/{audience_id}/contacts/{contact_id}\n@desc Get Contact\n@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).}\n@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.}\n@returns(200)\n\n@endpoint PATCH /audiences/{audience_id}/contacts/{contact_id}\n@desc Update Contact\n@required {body: map, audience_id: any # The unique ID for the audience., contact_id: any # The unique id for the contact.}\n@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.}\n@returns(200)\n\n@endpoint POST /audiences/{audience_id}/contacts/{contact_id}/actions/archive\n@desc Archive Contact\n@required {audience_id: any # The unique ID for the audience., contact_id: any # The unique id for the contact.}\n@returns(204) Empty Response\n\n@endpoint POST /audiences/{audience_id}/contacts/{contact_id}/actions/forget\n@desc Forget Contact\n@required {audience_id: any # The unique ID for the audience., contact_id: any # The unique id for the contact.}\n@returns(204) Empty Response\n\n@endgroup\n\n@group authorized-apps\n@endpoint GET /authorized-apps\n@desc List authorized apps\n@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.}\n@returns(200)\n\n@endpoint GET /authorized-apps/{app_id}\n@desc Get authorized app info\n@required {app_id: any # The unique id for the connected authorized application.}\n@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.}\n@returns(200)\n\n@endgroup\n\n@group automations\n@endpoint GET /automations\n@desc List automations\n@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.}\n@returns(200)\n\n@endpoint POST /automations\n@desc Add automation\n@required {body: map}\n@returns(200)\n\n@endpoint GET /automations/{workflow_id}\n@desc Get automation info\n@required {workflow_id: any # The unique id for the Automation workflow.}\n@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.}\n@returns(200)\n\n@endpoint POST /automations/{workflow_id}/actions/pause-all-emails\n@desc Pause automation emails\n@required {workflow_id: any # The unique id for the Automation workflow.}\n@returns(204) Empty Response\n\n@endpoint POST /automations/{workflow_id}/actions/start-all-emails\n@desc Start automation emails\n@required {workflow_id: any # The unique id for the Automation workflow.}\n@returns(204) Empty Response\n\n@endpoint POST /automations/{workflow_id}/actions/archive\n@desc Archive automation\n@required {workflow_id: any # The unique id for the Automation workflow.}\n@returns(204) Empty Response\n\n@endpoint GET /automations/{workflow_id}/emails\n@desc List automated emails\n@required {workflow_id: any # The unique id for the Automation workflow.}\n@returns(200)\n\n@endpoint GET /automations/{workflow_id}/emails/{workflow_email_id}\n@desc Get workflow email info\n@required {workflow_id: any # The unique id for the Automation workflow., workflow_email_id: any # The unique id for the Automation workflow email.}\n@returns(200)\n\n@endpoint DELETE /automations/{workflow_id}/emails/{workflow_email_id}\n@desc Delete workflow email\n@required {workflow_id: any # The unique id for the Automation workflow., workflow_email_id: any # The unique id for the Automation workflow email.}\n@returns(204) Empty Response\n\n@endpoint PATCH /automations/{workflow_id}/emails/{workflow_email_id}\n@desc Update workflow email\n@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}\n@returns(200)\n\n@endpoint GET /automations/{workflow_id}/emails/{workflow_email_id}/queue\n@desc List automated email subscribers\n@required {workflow_id: any # The unique id for the Automation workflow., workflow_email_id: any # The unique id for the Automation workflow email.}\n@returns(200)\n\n@endpoint POST /automations/{workflow_id}/emails/{workflow_email_id}/queue\n@desc Add subscriber to workflow email\n@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}\n@returns(200)\n\n@endpoint GET /automations/{workflow_id}/emails/{workflow_email_id}/queue/{subscriber_hash}\n@desc Get automated email subscriber\n@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.}\n@returns(200)\n\n@endpoint POST /automations/{workflow_id}/emails/{workflow_email_id}/actions/pause\n@desc Pause automated email\n@required {workflow_id: any # The unique id for the Automation workflow., workflow_email_id: any # The unique id for the Automation workflow email.}\n@returns(204) Empty Response\n\n@endpoint POST /automations/{workflow_id}/emails/{workflow_email_id}/actions/start\n@desc Start automated email\n@required {workflow_id: any # The unique id for the Automation workflow., workflow_email_id: any # The unique id for the Automation workflow email.}\n@returns(204) Empty Response\n\n@endpoint GET /automations/{workflow_id}/removed-subscribers\n@desc List subscribers removed from workflow\n@required {workflow_id: any # The unique id for the Automation workflow.}\n@returns(200)\n\n@endpoint POST /automations/{workflow_id}/removed-subscribers\n@desc Remove subscriber from workflow\n@required {workflow_id: any # The unique id for the Automation workflow., body: map}\n@returns(200)\n\n@endpoint GET /automations/{workflow_id}/removed-subscribers/{subscriber_hash}\n@desc Get subscriber removed from workflow\n@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.}\n@returns(200)\n\n@endgroup\n\n@group batches\n@endpoint GET /batches\n@desc List batch requests\n@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.}\n@returns(200)\n\n@endpoint POST /batches\n@desc Start batch operation\n@required {body: map}\n@returns(200)\n\n@endpoint GET /batches/{batch_id}\n@desc Get batch operation status\n@required {batch_id: any # The unique id for the batch operation.}\n@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.}\n@returns(200)\n\n@endpoint DELETE /batches/{batch_id}\n@desc Delete batch request\n@required {batch_id: any # The unique id for the batch operation.}\n@returns(204) Empty Response\n\n@endgroup\n\n@group batch-webhooks\n@endpoint GET /batch-webhooks\n@desc List batch webhooks\n@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.}\n@returns(200)\n\n@endpoint POST /batch-webhooks\n@desc Add batch webhook\n@required {body: map}\n@returns(200)\n\n@endpoint GET /batch-webhooks/{batch_webhook_id}\n@desc Get batch webhook info\n@required {batch_webhook_id: any # The unique id for the batch webhook.}\n@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.}\n@returns(200)\n\n@endpoint PATCH /batch-webhooks/{batch_webhook_id}\n@desc Update batch webhook\n@required {batch_webhook_id: any # The unique id for the batch webhook., body: map}\n@returns(200)\n\n@endpoint DELETE /batch-webhooks/{batch_webhook_id}\n@desc Delete batch webhook\n@required {batch_webhook_id: any # The unique id for the batch webhook.}\n@returns(204) Empty Response\n\n@endgroup\n\n@group template-folders\n@endpoint GET /template-folders\n@desc List template folders\n@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.}\n@returns(200)\n\n@endpoint POST /template-folders\n@desc Add template folder\n@required {body: map}\n@returns(200)\n\n@endpoint GET /template-folders/{folder_id}\n@desc Get template folder\n@required {folder_id: any # The unique id for the template folder.}\n@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.}\n@returns(200)\n\n@endpoint PATCH /template-folders/{folder_id}\n@desc Update template folder\n@required {folder_id: any # The unique id for the template folder., body: map}\n@returns(200)\n\n@endpoint DELETE /template-folders/{folder_id}\n@desc Delete template folder\n@required {folder_id: any # The unique id for the template folder.}\n@returns(204) Empty Response\n\n@endgroup\n\n@group campaign-folders\n@endpoint GET /campaign-folders\n@desc List campaign folders\n@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.}\n@returns(200)\n\n@endpoint POST /campaign-folders\n@desc Add campaign folder\n@required {body: map}\n@returns(200)\n\n@endpoint GET /campaign-folders/{folder_id}\n@desc Get campaign folder\n@required {folder_id: any # The unique id for the campaign folder.}\n@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.}\n@returns(200)\n\n@endpoint PATCH /campaign-folders/{folder_id}\n@desc Update campaign folder\n@required {folder_id: any # The unique id for the campaign folder., body: map}\n@returns(200)\n\n@endpoint DELETE /campaign-folders/{folder_id}\n@desc Delete campaign folder\n@required {folder_id: any # The unique id for the campaign folder.}\n@returns(204) Empty Response\n\n@endgroup\n\n@group campaigns\n@endpoint GET /campaigns\n@desc List campaigns\n@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.}\n@returns(200)\n\n@endpoint POST /campaigns\n@desc Add campaign\n@required {body: map}\n@returns(200)\n\n@endpoint GET /campaigns/{campaign_id}\n@desc Get campaign info\n@required {campaign_id: any # The unique id for the campaign.}\n@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.}\n@returns(200)\n\n@endpoint PATCH /campaigns/{campaign_id}\n@desc Update campaign settings\n@required {campaign_id: any # The unique id for the campaign., body: map}\n@returns(200)\n\n@endpoint DELETE /campaigns/{campaign_id}\n@desc Delete campaign\n@required {campaign_id: any # The unique id for the campaign.}\n@returns(204) Empty Response\n\n@endpoint POST /campaigns/{campaign_id}/actions/cancel-send\n@desc Cancel campaign\n@required {campaign_id: any # The unique id for the campaign.}\n@returns(204) Empty Response\n\n@endpoint POST /campaigns/{campaign_id}/actions/replicate\n@desc Replicate campaign\n@required {campaign_id: any # The unique id for the campaign.}\n@returns(200)\n\n@endpoint POST /campaigns/{campaign_id}/actions/send\n@desc Send campaign\n@required {campaign_id: any # The unique id for the campaign.}\n@returns(204) Empty Response\n\n@endpoint POST /campaigns/{campaign_id}/actions/schedule\n@desc Schedule campaign\n@required {campaign_id: any # The unique id for the campaign., body: map}\n@returns(204) Empty Response\n\n@endpoint POST /campaigns/{campaign_id}/actions/unschedule\n@desc Unschedule campaign\n@required {campaign_id: any # The unique id for the campaign.}\n@returns(204) Empty Response\n\n@endpoint POST /campaigns/{campaign_id}/actions/test\n@desc Send test email\n@required {campaign_id: any # The unique id for the campaign., body: map}\n@returns(204) Empty Response\n\n@endpoint POST /campaigns/{campaign_id}/actions/pause\n@desc Pause rss campaign\n@required {campaign_id: any # The unique id for the campaign.}\n@returns(204) Empty Response\n\n@endpoint POST /campaigns/{campaign_id}/actions/resume\n@desc Resume rss campaign\n@required {campaign_id: any # The unique id for the campaign.}\n@returns(204) Empty Response\n\n@endpoint POST /campaigns/{campaign_id}/actions/create-resend\n@desc Resend campaign\n@required {campaign_id: any # The unique id for the campaign.}\n@optional {body: map}\n@returns(200)\n\n@endpoint GET /campaigns/{campaign_id}/content\n@desc Get campaign content\n@required {campaign_id: any # The unique id for the campaign.}\n@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.}\n@returns(200)\n\n@endpoint PUT /campaigns/{campaign_id}/content\n@desc Set campaign content\n@required {campaign_id: any # The unique id for the campaign., body: map}\n@returns(200)\n\n@endpoint GET /campaigns/{campaign_id}/feedback\n@desc List campaign feedback\n@required {campaign_id: any # The unique id for the campaign.}\n@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.}\n@returns(200)\n\n@endpoint POST /campaigns/{campaign_id}/feedback\n@desc Add campaign feedback\n@required {campaign_id: any # The unique id for the campaign., body: map}\n@returns(200)\n\n@endpoint GET /campaigns/{campaign_id}/feedback/{feedback_id}\n@desc Get campaign feedback message\n@required {campaign_id: any # The unique id for the campaign., feedback_id: any # The unique id for the feedback message.}\n@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.}\n@returns(200)\n\n@endpoint PATCH /campaigns/{campaign_id}/feedback/{feedback_id}\n@desc Update campaign feedback message\n@required {campaign_id: any # The unique id for the campaign., feedback_id: any # The unique id for the feedback message., body: map}\n@returns(200)\n\n@endpoint DELETE /campaigns/{campaign_id}/feedback/{feedback_id}\n@desc Delete campaign feedback message\n@required {campaign_id: any # The unique id for the campaign., feedback_id: any # The unique id for the feedback message.}\n@returns(204) Empty Response\n\n@endpoint GET /campaigns/{campaign_id}/send-checklist\n@desc Get campaign send checklist\n@required {campaign_id: any # The unique id for the campaign.}\n@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.}\n@returns(200)\n\n@endgroup\n\n@group connected-sites\n@endpoint GET /connected-sites\n@desc List connected sites\n@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.}\n@returns(200)\n\n@endpoint POST /connected-sites\n@desc Add connected site\n@required {body: map}\n@returns(200)\n\n@endpoint GET /connected-sites/{connected_site_id}\n@desc Get connected site\n@required {connected_site_id: any # The unique identifier for the site.}\n@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.}\n@returns(200)\n\n@endpoint DELETE /connected-sites/{connected_site_id}\n@desc Delete connected site\n@required {connected_site_id: any # The unique identifier for the site.}\n@returns(204) Empty Response\n\n@endpoint POST /connected-sites/{connected_site_id}/actions/verify-script-installation\n@desc Verify connected site script\n@required {connected_site_id: any # The unique identifier for the site.}\n@returns(204) Empty Response\n\n@endgroup\n\n@group conversations\n@endpoint GET /conversations\n@desc List conversations\n@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.}\n@returns(200)\n\n@endpoint GET /conversations/{conversation_id}\n@desc Get conversation\n@required {conversation_id: any # The unique id for the conversation.}\n@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.}\n@returns(200)\n\n@endpoint GET /conversations/{conversation_id}/messages\n@desc List messages\n@required {conversation_id: any # The unique id for the conversation.}\n@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.}\n@returns(200)\n\n@endpoint GET /conversations/{conversation_id}/messages/{message_id}\n@desc Get message\n@required {conversation_id: any # The unique id for the conversation., message_id: any # The unique id for the conversation message.}\n@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.}\n@returns(200)\n\n@endgroup\n\n@group customer-journeys\n@endpoint POST /customer-journeys/journeys/{journey_id}/steps/{step_id}/actions/trigger\n@desc Customer Journeys API trigger for a contact\n@required {journey_id: any # The id for the flow., step_id: any # The id for the Step., body: map}\n@returns(204) An empty response\n\n@endgroup\n\n@group file-manager\n@endpoint GET /file-manager/files\n@desc List stored files\n@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.}\n@returns(200)\n\n@endpoint POST /file-manager/files\n@desc Add file\n@required {body: map}\n@returns(200)\n\n@endpoint GET /file-manager/files/{file_id}\n@desc Get file\n@required {file_id: any # The unique id for the File Manager file.}\n@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.}\n@returns(200)\n\n@endpoint PATCH /file-manager/files/{file_id}\n@desc Update file\n@required {file_id: any # The unique id for the File Manager file., body: map}\n@returns(200)\n\n@endpoint DELETE /file-manager/files/{file_id}\n@desc Delete file\n@required {file_id: any # The unique id for the File Manager file.}\n@returns(204) Empty Response\n\n@endpoint GET /file-manager/folders\n@desc List folders\n@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.}\n@returns(200)\n\n@endpoint POST /file-manager/folders\n@desc Add folder\n@required {body: map}\n@returns(200)\n\n@endpoint GET /file-manager/folders/{folder_id}\n@desc Get folder\n@required {folder_id: any # The unique id for the File Manager folder.}\n@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.}\n@returns(200)\n\n@endpoint PATCH /file-manager/folders/{folder_id}\n@desc Update folder\n@required {folder_id: any # The unique id for the File Manager folder., body: map}\n@returns(200)\n\n@endpoint DELETE /file-manager/folders/{folder_id}\n@desc Delete folder\n@required {folder_id: any # The unique id for the File Manager folder.}\n@returns(204) Empty Response\n\n@endpoint GET /file-manager/folders/{folder_id}/files\n@desc List stored files\n@required {folder_id: any # The unique id for the File Manager folder.}\n@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.}\n@returns(200)\n\n@endgroup\n\n@group lists\n@endpoint GET /lists\n@desc Get lists info\n@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.}\n@returns(200)\n\n@endpoint POST /lists\n@desc Add list\n@required {body: map}\n@returns(200)\n\n@endpoint GET /lists/{list_id}\n@desc Get list info\n@required {list_id: any # The unique ID for the list.}\n@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.}\n@returns(200)\n\n@endpoint PATCH /lists/{list_id}\n@desc Update lists\n@required {list_id: any # The unique ID for the list., body: map}\n@returns(200)\n\n@endpoint DELETE /lists/{list_id}\n@desc Delete list\n@required {list_id: any # The unique ID for the list.}\n@returns(204) Empty Response\n\n@endpoint POST /lists/{list_id}\n@desc Batch subscribe or unsubscribe\n@required {list_id: any # The unique ID for the list., body: map}\n@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.}\n@returns(200)\n\n@endpoint GET /lists/{list_id}/abuse-reports\n@desc List abuse reports\n@required {list_id: any # The unique ID for the list.}\n@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.}\n@returns(200)\n\n@endpoint GET /lists/{list_id}/abuse-reports/{report_id}\n@desc Get abuse report\n@required {list_id: any # The unique ID for the list., report_id: any # The id for the abuse report.}\n@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.}\n@returns(200)\n\n@endpoint GET /lists/{list_id}/activity\n@desc List recent activity\n@required {list_id: any # The unique ID for the list.}\n@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.}\n@returns(200)\n\n@endpoint GET /lists/{list_id}/clients\n@desc List top email clients\n@required {list_id: any # The unique ID for the list.}\n@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.}\n@returns(200)\n\n@endpoint GET /lists/{list_id}/growth-history\n@desc List growth history data\n@required {list_id: any # The unique ID for the list.}\n@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.}\n@returns(200)\n\n@endpoint GET /lists/{list_id}/growth-history/{month}\n@desc Get growth history by month\n@required {list_id: any # The unique ID for the list., month: any # A specific month of list growth history.}\n@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.}\n@returns(200)\n\n@endpoint GET /lists/{list_id}/interest-categories\n@desc List interest categories\n@required {list_id: any # The unique ID for the list.}\n@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}\n@returns(200)\n\n@endpoint POST /lists/{list_id}/interest-categories\n@desc Add interest category\n@required {list_id: any # The unique ID for the list., body: map}\n@returns(200)\n\n@endpoint GET /lists/{list_id}/interest-categories/{interest_category_id}\n@desc Get interest category info\n@required {list_id: any # The unique ID for the list., interest_category_id: any # The unique ID for the interest category.}\n@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.}\n@returns(200)\n\n@endpoint PATCH /lists/{list_id}/interest-categories/{interest_category_id}\n@desc Update interest category\n@required {list_id: any # The unique ID for the list., interest_category_id: any # The unique ID for the interest category., body: map}\n@returns(200)\n\n@endpoint DELETE /lists/{list_id}/interest-categories/{interest_category_id}\n@desc Delete interest category\n@required {list_id: any # The unique ID for the list., interest_category_id: any # The unique ID for the interest category.}\n@returns(204) Empty Response\n\n@endpoint GET /lists/{list_id}/interest-categories/{interest_category_id}/interests\n@desc List interests in category\n@required {list_id: any # The unique ID for the list., interest_category_id: any # The unique ID for the interest category.}\n@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.}\n@returns(200)\n\n@endpoint POST /lists/{list_id}/interest-categories/{interest_category_id}/interests\n@desc Add interest in category\n@required {list_id: any # The unique ID for the list., interest_category_id: any # The unique ID for the interest category., body: map}\n@returns(200)\n\n@endpoint GET /lists/{list_id}/interest-categories/{interest_category_id}/interests/{interest_id}\n@desc Get interest in category\n@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'.}\n@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.}\n@returns(200)\n\n@endpoint PATCH /lists/{list_id}/interest-categories/{interest_category_id}/interests/{interest_id}\n@desc Update interest in category\n@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}\n@returns(200)\n\n@endpoint DELETE /lists/{list_id}/interest-categories/{interest_category_id}/interests/{interest_id}\n@desc Delete interest in category\n@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'.}\n@returns(204) Empty Response\n\n@endpoint GET /lists/{list_id}/segments\n@desc List segments\n@required {list_id: any # The unique ID for the list.}\n@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.}\n@returns(200)\n\n@endpoint POST /lists/{list_id}/segments\n@desc Add segment\n@required {list_id: any # The unique ID for the list., body: map}\n@returns(200)\n\n@endpoint GET /lists/{list_id}/segments/{segment_id}\n@desc Get segment info\n@required {list_id: any # The unique ID for the list., segment_id: any # The unique id for the segment.}\n@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}\n@returns(200)\n\n@endpoint DELETE /lists/{list_id}/segments/{segment_id}\n@desc Delete segment\n@required {list_id: any # The unique ID for the list., segment_id: any # The unique id for the segment.}\n@returns(204) Empty Response\n\n@endpoint PATCH /lists/{list_id}/segments/{segment_id}\n@desc Update segment\n@required {list_id: any # The unique ID for the list., segment_id: any # The unique id for the segment., body: map}\n@returns(200)\n\n@endpoint POST /lists/{list_id}/segments/{segment_id}\n@desc Batch add or remove members\n@required {body: map, list_id: any # The unique ID for the list., segment_id: any # The unique id for the segment.}\n@returns(200)\n\n@endpoint GET /lists/{list_id}/segments/{segment_id}/members\n@desc List members in segment\n@required {list_id: any # The unique ID for the list., segment_id: any # The unique id for the segment.}\n@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}\n@returns(200)\n\n@endpoint POST /lists/{list_id}/segments/{segment_id}/members\n@desc Add member to segment\n@required {list_id: any # The unique ID for the list., segment_id: any # The unique id for the segment., body: map}\n@returns(200)\n\n@endpoint DELETE /lists/{list_id}/segments/{segment_id}/members/{subscriber_hash}\n@desc Remove list member from segment\n@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.}\n@returns(204) Empty Response\n\n@endpoint GET /lists/{list_id}/tag-search\n@desc Search for tags on a list by name.\n@required {list_id: any # The unique ID for the list.}\n@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.}\n@returns(200)\n\n@endpoint GET /lists/{list_id}/members\n@desc List members info\n@required {list_id: any # The unique ID for the list.}\n@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.}\n@returns(200)\n\n@endpoint POST /lists/{list_id}/members\n@desc Add member to list\n@required {list_id: any # The unique ID for the list., body: map}\n@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.}\n@returns(200)\n\n@endpoint GET /lists/{list_id}/members/{subscriber_hash}\n@desc Get member info\n@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.}\n@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.}\n@returns(200)\n\n@endpoint PUT /lists/{list_id}/members/{subscriber_hash}\n@desc Add or update list member\n@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}\n@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.}\n@returns(200)\n\n@endpoint PATCH /lists/{list_id}/members/{subscriber_hash}\n@desc Update list member\n@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}\n@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.}\n@returns(200)\n\n@endpoint DELETE /lists/{list_id}/members/{subscriber_hash}\n@desc Archive list member\n@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.}\n@returns(204) Empty Response\n\n@endpoint GET /lists/{list_id}/members/{subscriber_hash}/activity\n@desc View recent activity 50\n@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.}\n@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.}\n@returns(200)\n\n@endpoint GET /lists/{list_id}/members/{subscriber_hash}/activity-feed\n@desc View recent activity\n@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.}\n@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\".}\n@returns(200)\n\n@endpoint GET /lists/{list_id}/members/{subscriber_hash}/tags\n@desc List member tags\n@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.}\n@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.}\n@returns(200)\n\n@endpoint POST /lists/{list_id}/members/{subscriber_hash}/tags\n@desc Add or remove member tags\n@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}\n@returns(204) Empty Response\n\n@endpoint GET /lists/{list_id}/members/{subscriber_hash}/events\n@desc List member events\n@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.}\n@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.}\n@returns(200)\n\n@endpoint POST /lists/{list_id}/members/{subscriber_hash}/events\n@desc Add event\n@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}\n@returns(204) Empty Response\n\n@endpoint GET /lists/{list_id}/members/{subscriber_hash}/goals\n@desc List member goal events\n@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.}\n@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.}\n@returns(200)\n\n@endpoint GET /lists/{list_id}/members/{subscriber_hash}/notes\n@desc List recent member notes\n@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.}\n@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.}\n@returns(200)\n\n@endpoint POST /lists/{list_id}/members/{subscriber_hash}/notes\n@desc Add member note\n@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}\n@returns(200)\n\n@endpoint GET /lists/{list_id}/members/{subscriber_hash}/notes/{note_id}\n@desc Get member note\n@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.}\n@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.}\n@returns(200)\n\n@endpoint PATCH /lists/{list_id}/members/{subscriber_hash}/notes/{note_id}\n@desc Update note\n@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}\n@returns(200)\n\n@endpoint DELETE /lists/{list_id}/members/{subscriber_hash}/notes/{note_id}\n@desc Delete note\n@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.}\n@returns(204) Empty Response\n\n@endpoint POST /lists/{list_id}/members/{subscriber_hash}/actions/delete-permanent\n@desc Delete list member\n@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.}\n@returns(204) Empty Response\n\n@endpoint GET /lists/{list_id}/merge-fields\n@desc List merge fields\n@required {list_id: any # The unique ID for the list.}\n@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.}\n@returns(200)\n\n@endpoint POST /lists/{list_id}/merge-fields\n@desc Add merge field\n@required {list_id: any # The unique ID for the list., body: map}\n@returns(200)\n\n@endpoint GET /lists/{list_id}/merge-fields/{merge_id}\n@desc Get merge field\n@required {list_id: any # The unique ID for the list., merge_id: any # The id for the merge field.}\n@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.}\n@returns(200)\n\n@endpoint PATCH /lists/{list_id}/merge-fields/{merge_id}\n@desc Update merge field\n@required {list_id: any # The unique ID for the list., merge_id: any # The id for the merge field., body: map}\n@returns(200)\n\n@endpoint DELETE /lists/{list_id}/merge-fields/{merge_id}\n@desc Delete merge field\n@required {list_id: any # The unique ID for the list., merge_id: any # The id for the merge field.}\n@returns(204) Empty Response\n\n@endpoint GET /lists/{list_id}/webhooks\n@desc List webhooks\n@required {list_id: any # The unique ID for the list.}\n@returns(200)\n\n@endpoint POST /lists/{list_id}/webhooks\n@desc Add webhook\n@required {list_id: any # The unique ID for the list., body: map}\n@returns(200)\n\n@endpoint GET /lists/{list_id}/webhooks/{webhook_id}\n@desc Get webhook info\n@required {list_id: any # The unique ID for the list., webhook_id: any # The webhook's id.}\n@returns(200)\n\n@endpoint DELETE /lists/{list_id}/webhooks/{webhook_id}\n@desc Delete webhook\n@required {list_id: any # The unique ID for the list., webhook_id: any # The webhook's id.}\n@returns(204) Empty Response\n\n@endpoint PATCH /lists/{list_id}/webhooks/{webhook_id}\n@desc Update webhook\n@required {list_id: any # The unique ID for the list., webhook_id: any # The webhook's id., body: map}\n@returns(200)\n\n@endpoint GET /lists/{list_id}/signup-forms\n@desc List signup forms\n@required {list_id: any # The unique ID for the list.}\n@returns(200)\n\n@endpoint POST /lists/{list_id}/signup-forms\n@desc Customize signup form\n@required {list_id: any # The unique ID for the list., body: map}\n@returns(200)\n\n@endpoint GET /lists/{list_id}/locations\n@desc List locations\n@required {list_id: any # The unique ID for the list.}\n@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.}\n@returns(200)\n\n@endpoint GET /lists/{list_id}/surveys\n@desc Get information about all surveys for a list\n@required {list_id: any # The unique ID for the list.}\n@returns(200)\n\n@endpoint GET /lists/{list_id}/surveys/{survey_id}\n@desc Get survey\n@required {list_id: any # The unique ID for the list., survey_id: any # The ID of the survey.}\n@returns(200)\n\n@endpoint POST /lists/{list_id}/surveys/{survey_id}/actions/publish\n@desc Publish a Survey\n@required {list_id: any # The unique ID for the list., survey_id: any # The ID of the survey.}\n@returns(200) Survey Published\n\n@endpoint POST /lists/{list_id}/surveys/{survey_id}/actions/unpublish\n@desc Unpublish a Survey\n@required {list_id: any # The unique ID for the list., survey_id: any # The ID of the survey.}\n@returns(200) Survey Instance\n\n@endpoint POST /lists/{list_id}/surveys/{survey_id}/actions/create-email\n@desc Create a Survey Campaign\n@required {list_id: any # The unique ID for the list., survey_id: any # The ID of the survey.}\n@returns(200) Campaign Instance\n\n@endgroup\n\n@group landing-pages\n@endpoint GET /landing-pages\n@desc List landing pages\n@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}\n@returns(200) Landing Pages Collection\n\n@endpoint POST /landing-pages\n@desc Add landing page\n@required {body: map}\n@optional {use_default_list: any # Will create the Landing Page using the account's Default List instead of requiring a list_id.}\n@returns(200)\n\n@endpoint GET /landing-pages/{page_id}\n@desc Get landing page info\n@required {page_id: any # The unique id for the page.}\n@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.}\n@returns(200) Landing Pages Instance\n\n@endpoint PATCH /landing-pages/{page_id}\n@desc Update landing page\n@required {page_id: any # The unique id for the page., body: map}\n@returns(200)\n\n@endpoint DELETE /landing-pages/{page_id}\n@desc Delete landing page\n@required {page_id: any # The unique id for the page.}\n@returns(204) Empty Response\n\n@endpoint POST /landing-pages/{page_id}/actions/publish\n@desc Publish landing page\n@required {page_id: any # The unique id for the page.}\n@returns(204) Empty Response\n\n@endpoint POST /landing-pages/{page_id}/actions/unpublish\n@desc Unpublish landing page\n@required {page_id: any # The unique id for the page.}\n@returns(204) Empty Response\n\n@endpoint GET /landing-pages/{page_id}/content\n@desc Get landing page content\n@required {page_id: any # The unique id for the page.}\n@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.}\n@returns(200)\n\n@endgroup\n\n@group reports\n@endpoint GET /reports\n@desc List campaign reports\n@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.}\n@returns(200)\n\n@endpoint GET /reports/{campaign_id}\n@desc Get campaign report\n@required {campaign_id: any # The unique id for the campaign.}\n@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.}\n@returns(200)\n\n@endpoint GET /reports/{campaign_id}/abuse-reports\n@desc List abuse reports\n@required {campaign_id: any # The unique id for the campaign.}\n@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.}\n@returns(200)\n\n@endpoint GET /reports/{campaign_id}/abuse-reports/{report_id}\n@desc Get abuse report\n@required {campaign_id: any # The unique id for the campaign., report_id: any # The id for the abuse report.}\n@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.}\n@returns(200)\n\n@endpoint GET /reports/{campaign_id}/advice\n@desc List campaign feedback\n@required {campaign_id: any # The unique id for the campaign.}\n@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.}\n@returns(200)\n\n@endpoint GET /reports/{campaign_id}/click-details\n@desc List campaign details\n@required {campaign_id: any # The unique id for the campaign.}\n@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.}\n@returns(200)\n\n@endpoint GET /reports/{campaign_id}/click-details/{link_id}\n@desc Get campaign link details\n@required {campaign_id: any # The unique id for the campaign., link_id: any # The id for the link.}\n@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.}\n@returns(200)\n\n@endpoint GET /reports/{campaign_id}/click-details/{link_id}/members\n@desc List clicked link subscribers\n@required {campaign_id: any # The unique id for the campaign., link_id: any # The id for the link.}\n@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.}\n@returns(200)\n\n@endpoint GET /reports/{campaign_id}/click-details/{link_id}/members/{subscriber_hash}\n@desc Get clicked link subscriber\n@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.}\n@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.}\n@returns(200)\n\n@endpoint GET /reports/{campaign_id}/open-details\n@desc List campaign open details\n@required {campaign_id: any # The unique id for the campaign.}\n@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.}\n@returns(200)\n\n@endpoint GET /reports/{campaign_id}/open-details/{subscriber_hash}\n@desc Get opened campaign subscriber\n@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.}\n@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.}\n@returns(200)\n\n@endpoint GET /reports/{campaign_id}/domain-performance\n@desc List domain performance stats\n@required {campaign_id: any # The unique id for the campaign.}\n@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.}\n@returns(200)\n\n@endpoint GET /reports/{campaign_id}/eepurl\n@desc List EepURL activity\n@required {campaign_id: any # The unique id for the campaign.}\n@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.}\n@returns(200)\n\n@endpoint GET /reports/{campaign_id}/email-activity\n@desc List email activity\n@required {campaign_id: any # The unique id for the campaign.}\n@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.}\n@returns(200)\n\n@endpoint GET /reports/{campaign_id}/email-activity/{subscriber_hash}\n@desc Get subscriber email activity\n@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.}\n@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.}\n@returns(200)\n\n@endpoint GET /reports/{campaign_id}/locations\n@desc List top open activities\n@required {campaign_id: any # The unique id for the campaign.}\n@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.}\n@returns(200)\n\n@endpoint GET /reports/{campaign_id}/sent-to\n@desc List campaign recipients\n@required {campaign_id: any # The unique id for the campaign.}\n@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.}\n@returns(200)\n\n@endpoint GET /reports/{campaign_id}/sent-to/{subscriber_hash}\n@desc Get campaign recipient info\n@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.}\n@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.}\n@returns(200)\n\n@endpoint GET /reports/{campaign_id}/sub-reports\n@desc List child campaign reports\n@required {campaign_id: any # The unique id for the campaign.}\n@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.}\n@returns(200)\n\n@endpoint GET /reports/{campaign_id}/unsubscribed\n@desc List unsubscribed members\n@required {campaign_id: any # The unique id for the campaign.}\n@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.}\n@returns(200)\n\n@endpoint GET /reports/{campaign_id}/unsubscribed/{subscriber_hash}\n@desc Get unsubscribed member\n@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.}\n@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.}\n@returns(200)\n\n@endpoint GET /reports/{campaign_id}/ecommerce-product-activity\n@desc List campaign product activity\n@required {campaign_id: any # The unique id for the campaign.}\n@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.}\n@returns(200) Ecommerce Product Activity Instance\n\n@endgroup\n\n@group templates\n@endpoint GET /templates\n@desc List templates\n@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.}\n@returns(200)\n\n@endpoint POST /templates\n@desc Add template\n@required {body: map}\n@returns(200)\n\n@endpoint GET /templates/{template_id}\n@desc Get template info\n@required {template_id: any # The unique id for the template.}\n@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.}\n@returns(200)\n\n@endpoint PATCH /templates/{template_id}\n@desc Update template\n@required {template_id: any # The unique id for the template., body: map}\n@returns(200)\n\n@endpoint DELETE /templates/{template_id}\n@desc Delete template\n@required {template_id: any # The unique id for the template.}\n@returns(204) Empty Response\n\n@endpoint GET /templates/{template_id}/default-content\n@desc View default content\n@required {template_id: any # The unique id for the template.}\n@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.}\n@returns(200)\n\n@endgroup\n\n@group ecommerce\n@endpoint GET /ecommerce/orders\n@desc List account orders\n@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.}\n@returns(200)\n\n@endpoint GET /ecommerce/stores\n@desc List stores\n@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.}\n@returns(200)\n\n@endpoint POST /ecommerce/stores\n@desc Add store\n@required {body: map}\n@returns(200)\n\n@endpoint GET /ecommerce/stores/{store_id}\n@desc Get store info\n@required {store_id: any # The store id.}\n@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.}\n@returns(200)\n\n@endpoint PATCH /ecommerce/stores/{store_id}\n@desc Update store\n@required {store_id: any # The store id., body: map}\n@returns(200)\n\n@endpoint DELETE /ecommerce/stores/{store_id}\n@desc Delete store\n@required {store_id: any # The store id.}\n@returns(204) Empty Response\n\n@endpoint GET /ecommerce/stores/{store_id}/carts\n@desc List carts\n@required {store_id: any # The store id.}\n@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.}\n@returns(200)\n\n@endpoint POST /ecommerce/stores/{store_id}/carts\n@desc Add cart\n@required {store_id: any # The store id., body: map}\n@returns(200)\n\n@endpoint GET /ecommerce/stores/{store_id}/carts/{cart_id}\n@desc Get cart info\n@required {store_id: any # The store id., cart_id: any # The id for the cart.}\n@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.}\n@returns(200)\n\n@endpoint PATCH /ecommerce/stores/{store_id}/carts/{cart_id}\n@desc Update cart\n@required {store_id: any # The store id., cart_id: any # The id for the cart., body: map}\n@returns(200)\n\n@endpoint DELETE /ecommerce/stores/{store_id}/carts/{cart_id}\n@desc Delete cart\n@required {store_id: any # The store id., cart_id: any # The id for the cart.}\n@returns(204) Empty Response\n\n@endpoint GET /ecommerce/stores/{store_id}/carts/{cart_id}/lines\n@desc List cart line items\n@required {store_id: any # The store id., cart_id: any # The id for the cart.}\n@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.}\n@returns(200)\n\n@endpoint POST /ecommerce/stores/{store_id}/carts/{cart_id}/lines\n@desc Add cart line item\n@required {store_id: any # The store id., cart_id: any # The id for the cart., body: map}\n@returns(200)\n\n@endpoint GET /ecommerce/stores/{store_id}/carts/{cart_id}/lines/{line_id}\n@desc Get cart line item\n@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.}\n@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.}\n@returns(200)\n\n@endpoint PATCH /ecommerce/stores/{store_id}/carts/{cart_id}/lines/{line_id}\n@desc Update cart line item\n@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}\n@returns(200)\n\n@endpoint DELETE /ecommerce/stores/{store_id}/carts/{cart_id}/lines/{line_id}\n@desc Delete cart line item\n@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.}\n@returns(204) Empty Response\n\n@endpoint GET /ecommerce/stores/{store_id}/customers\n@desc List customers\n@required {store_id: any # The store id.}\n@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.}\n@returns(200)\n\n@endpoint POST /ecommerce/stores/{store_id}/customers\n@desc Add customer\n@required {store_id: any # The store id., body: map}\n@returns(200)\n\n@endpoint GET /ecommerce/stores/{store_id}/customers/{customer_id}\n@desc Get customer info\n@required {store_id: any # The store id., customer_id: any # The id for the customer of a store.}\n@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.}\n@returns(200)\n\n@endpoint PUT /ecommerce/stores/{store_id}/customers/{customer_id}\n@desc Add or update customer\n@required {store_id: any # The store id., customer_id: any # The id for the customer of a store., body: map}\n@returns(200)\n\n@endpoint PATCH /ecommerce/stores/{store_id}/customers/{customer_id}\n@desc Update customer\n@required {store_id: any # The store id., customer_id: any # The id for the customer of a store., body: map}\n@returns(200)\n\n@endpoint DELETE /ecommerce/stores/{store_id}/customers/{customer_id}\n@desc Delete customer\n@required {store_id: any # The store id., customer_id: any # The id for the customer of a store.}\n@returns(204) Empty Response\n\n@endpoint GET /ecommerce/stores/{store_id}/promo-rules\n@desc List promo rules\n@required {store_id: any # The store id.}\n@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.}\n@returns(200)\n\n@endpoint POST /ecommerce/stores/{store_id}/promo-rules\n@desc Add promo rule\n@required {store_id: any # The store id., body: map}\n@returns(200)\n\n@endpoint GET /ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}\n@desc Get promo rule\n@required {store_id: any # The store id., promo_rule_id: any # The id for the promo rule of a store.}\n@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.}\n@returns(200)\n\n@endpoint PATCH /ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}\n@desc Update promo rule\n@required {store_id: any # The store id., promo_rule_id: any # The id for the promo rule of a store., body: map}\n@returns(200)\n\n@endpoint DELETE /ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}\n@desc Delete promo rule\n@required {store_id: any # The store id., promo_rule_id: any # The id for the promo rule of a store.}\n@returns(204) Empty Response\n\n@endpoint GET /ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}/promo-codes\n@desc List promo codes\n@required {promo_rule_id: any # The id for the promo rule of a store., store_id: any # The store id.}\n@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.}\n@returns(200)\n\n@endpoint POST /ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}/promo-codes\n@desc Add promo code\n@required {store_id: any # The store id., promo_rule_id: any # The id for the promo rule of a store., body: map}\n@returns(200)\n\n@endpoint GET /ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}/promo-codes/{promo_code_id}\n@desc Get promo code\n@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.}\n@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.}\n@returns(200)\n\n@endpoint PATCH /ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}/promo-codes/{promo_code_id}\n@desc Update promo code\n@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}\n@returns(200)\n\n@endpoint DELETE /ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}/promo-codes/{promo_code_id}\n@desc Delete promo code\n@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.}\n@returns(204) Empty Response\n\n@endpoint GET /ecommerce/stores/{store_id}/orders\n@desc List orders\n@required {store_id: any # The store id.}\n@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.}\n@returns(200)\n\n@endpoint POST /ecommerce/stores/{store_id}/orders\n@desc Add order\n@required {store_id: any # The store id., body: map}\n@returns(200)\n\n@endpoint GET /ecommerce/stores/{store_id}/orders/{order_id}\n@desc Get order info\n@required {store_id: any # The store id., order_id: any # The id for the order in a store.}\n@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.}\n@returns(200)\n\n@endpoint PUT /ecommerce/stores/{store_id}/orders/{order_id}\n@desc Add or update order\n@required {store_id: any # The store id., order_id: any # The id for the order in a store., body: map}\n@returns(200)\n\n@endpoint PATCH /ecommerce/stores/{store_id}/orders/{order_id}\n@desc Update order\n@required {store_id: any # The store id., order_id: any # The id for the order in a store., body: map}\n@returns(200)\n\n@endpoint DELETE /ecommerce/stores/{store_id}/orders/{order_id}\n@desc Delete order\n@required {store_id: any # The store id., order_id: any # The id for the order in a store.}\n@returns(204) Empty Response\n\n@endpoint GET /ecommerce/stores/{store_id}/orders/{order_id}/lines\n@desc List order line items\n@required {store_id: any # The store id., order_id: any # The id for the order in a store.}\n@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.}\n@returns(200)\n\n@endpoint POST /ecommerce/stores/{store_id}/orders/{order_id}/lines\n@desc Add order line item\n@required {store_id: any # The store id., order_id: any # The id for the order in a store., body: map}\n@returns(200)\n\n@endpoint GET /ecommerce/stores/{store_id}/orders/{order_id}/lines/{line_id}\n@desc Get order line item\n@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.}\n@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.}\n@returns(200)\n\n@endpoint PATCH /ecommerce/stores/{store_id}/orders/{order_id}/lines/{line_id}\n@desc Update order line item\n@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}\n@returns(200)\n\n@endpoint DELETE /ecommerce/stores/{store_id}/orders/{order_id}/lines/{line_id}\n@desc Delete order line item\n@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.}\n@returns(204) Empty Response\n\n@endpoint GET /ecommerce/stores/{store_id}/products\n@desc List product\n@required {store_id: any # The store id.}\n@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.}\n@returns(200)\n\n@endpoint POST /ecommerce/stores/{store_id}/products\n@desc Add product\n@required {store_id: any # The store id., body: map}\n@returns(200)\n\n@endpoint GET /ecommerce/stores/{store_id}/products/{product_id}\n@desc Get product info\n@required {store_id: any # The store id., product_id: any # The id for the product of a store.}\n@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.}\n@returns(200)\n\n@endpoint PATCH /ecommerce/stores/{store_id}/products/{product_id}\n@desc Update product\n@required {store_id: any # The store id., product_id: any # The id for the product of a store., body: map}\n@returns(200)\n\n@endpoint PUT /ecommerce/stores/{store_id}/products/{product_id}\n@desc Create or update product\n@required {store_id: any # The store id., product_id: any # The id for the product of a store., body: map}\n@returns(200)\n\n@endpoint DELETE /ecommerce/stores/{store_id}/products/{product_id}\n@desc Delete product\n@required {store_id: any # The store id., product_id: any # The id for the product of a store.}\n@returns(204) Empty Response\n\n@endpoint GET /ecommerce/stores/{store_id}/products/{product_id}/variants\n@desc List product variants\n@required {store_id: any # The store id., product_id: any # The id for the product of a store.}\n@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.}\n@returns(200)\n\n@endpoint POST /ecommerce/stores/{store_id}/products/{product_id}/variants\n@desc Add product variant\n@required {store_id: any # The store id., product_id: any # The id for the product of a store., body: map}\n@returns(200)\n\n@endpoint GET /ecommerce/stores/{store_id}/products/{product_id}/variants/{variant_id}\n@desc Get product variant info\n@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.}\n@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.}\n@returns(200)\n\n@endpoint PUT /ecommerce/stores/{store_id}/products/{product_id}/variants/{variant_id}\n@desc Add or update product variant\n@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}\n@returns(200)\n\n@endpoint PATCH /ecommerce/stores/{store_id}/products/{product_id}/variants/{variant_id}\n@desc Update product variant\n@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}\n@returns(200)\n\n@endpoint DELETE /ecommerce/stores/{store_id}/products/{product_id}/variants/{variant_id}\n@desc Delete product variant\n@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.}\n@returns(204) Empty Response\n\n@endpoint GET /ecommerce/stores/{store_id}/products/{product_id}/images\n@desc List product images\n@required {store_id: any # The store id., product_id: any # The id for the product of a store.}\n@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.}\n@returns(200)\n\n@endpoint POST /ecommerce/stores/{store_id}/products/{product_id}/images\n@desc Add product image\n@required {store_id: any # The store id., product_id: any # The id for the product of a store., body: map}\n@returns(200)\n\n@endpoint GET /ecommerce/stores/{store_id}/products/{product_id}/images/{image_id}\n@desc Get product image info\n@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.}\n@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.}\n@returns(200)\n\n@endpoint PATCH /ecommerce/stores/{store_id}/products/{product_id}/images/{image_id}\n@desc Update product image\n@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}\n@returns(200)\n\n@endpoint DELETE /ecommerce/stores/{store_id}/products/{product_id}/images/{image_id}\n@desc Delete product image\n@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.}\n@returns(204) Empty Response\n\n@endgroup\n\n@group search-campaigns\n@endpoint GET /search-campaigns\n@desc Search campaigns\n@required {query: any # The search query used to filter results.}\n@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.}\n@returns(200)\n\n@endgroup\n\n@group search-members\n@endpoint GET /search-members\n@desc Search members\n@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.}\n@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.}\n@returns(200)\n\n@endgroup\n\n@group ping\n@endpoint GET /ping\n@desc Ping\n@returns(200)\n\n@endgroup\n\n@group facebook-ads\n@endpoint GET /facebook-ads\n@desc List facebook ads\n@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.}\n@returns(200) List of Facebook Ad Instances\n\n@endpoint GET /facebook-ads/{outreach_id}\n@desc Get facebook ad info\n@required {outreach_id: any # The outreach id.}\n@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.}\n@returns(200) Facebook Ad Instance\n\n@endgroup\n\n@group reporting\n@endpoint GET /reporting/facebook-ads\n@desc List facebook ads reports\n@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.}\n@returns(200) List of Facebook Ad Report Instances\n\n@endpoint GET /reporting/facebook-ads/{outreach_id}\n@desc Get facebook ad report\n@required {outreach_id: any # The outreach id.}\n@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.}\n@returns(200) Facebook Ad report Instance\n\n@endpoint GET /reporting/facebook-ads/{outreach_id}/ecommerce-product-activity\n@desc List facebook ecommerce report\n@required {outreach_id: any # The outreach id.}\n@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.}\n@returns(200) Ecommerce Product Activity Instance\n\n@endpoint GET /reporting/landing-pages/{outreach_id}\n@desc Get landing page report\n@required {outreach_id: any # The outreach id.}\n@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.}\n@returns(200) Landing Page Report Instance\n\n@endpoint GET /reporting/landing-pages\n@desc List landing pages reports\n@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.}\n@returns(200) List of Landing Page Report Instances\n\n@endpoint GET /reporting/surveys\n@desc List survey reports\n@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.}\n@returns(200) List of Survey Report Instances\n\n@endpoint GET /reporting/surveys/{survey_id}\n@desc Get survey report\n@required {survey_id: any # The ID of the survey.}\n@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.}\n@returns(200) Survey Report Instance\n\n@endpoint GET /reporting/surveys/{survey_id}/questions\n@desc List survey question reports\n@required {survey_id: any # The ID of the survey.}\n@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.}\n@returns(200) List of Survey Question Report Instances\n\n@endpoint GET /reporting/surveys/{survey_id}/questions/{question_id}\n@desc Get survey question report\n@required {survey_id: any # The ID of the survey., question_id: any # The ID of the survey question.}\n@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.}\n@returns(200) Survey Question Report Instance\n\n@endpoint GET /reporting/surveys/{survey_id}/questions/{question_id}/answers\n@desc List answers for question\n@required {survey_id: any # The ID of the survey., question_id: any # The ID of the survey question.}\n@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.}\n@returns(200) List of Survey Question Answers\n\n@endpoint GET /reporting/surveys/{survey_id}/responses\n@desc List survey responses\n@required {survey_id: any # The ID of the survey.}\n@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.}\n@returns(200) List of survey responses\n\n@endpoint GET /reporting/surveys/{survey_id}/responses/{response_id}\n@desc Get survey response\n@required {survey_id: any # The ID of the survey., response_id: any # The ID of the survey response.}\n@returns(200) Get a single survey response.\n\n@endgroup\n\n@group verified-domains\n@endpoint GET /verified-domains/{domain_name}\n@desc Get domain info\n@required {domain_name: any # The domain name.}\n@returns(200)\n\n@endpoint DELETE /verified-domains/{domain_name}\n@desc Delete domain\n@required {domain_name: any # The domain name.}\n@returns(204) Empty Response\n\n@endpoint POST /verified-domains/{domain_name}/actions/verify\n@desc Verify domain\n@required {domain_name: any # The domain name., body: map}\n@returns(200) The domain being verified for sending.\n\n@endpoint GET /verified-domains\n@desc List sending domains\n@returns(200) The domains on the account.\n\n@endpoint POST /verified-domains\n@desc Add domain to account\n@required {body: map}\n@returns(200) The newly-created domain.\n\n@endgroup\n\n@end\n"}}