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

@group root
@endpoint GET /
@optional {fields: any, exclude_fields: any}
@returns(200)

@endgroup

@group activity-feed
@endpoint GET /activity-feed/chimp-chatter
@optional {count: any, offset: any}
@returns(200)

@endgroup

@group account-exports
@endpoint GET /account-exports
@optional {fields: any, exclude_fields: any, count: any, offset: any}
@returns(200)

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

@endpoint GET /account-exports/{export_id}
@required {export_id: any}
@optional {fields: any, exclude_fields: any}
@returns(200)

@endgroup

@group audiences
@endpoint GET /audiences
@optional {fields: any, exclude_fields: any, count: any, offset: any}
@returns(200)

@endpoint GET /audiences/{audience_id}
@required {audience_id: any}
@optional {fields: any, exclude_fields: any}
@returns(200)

@endpoint GET /audiences/{audience_id}/contacts
@required {audience_id: any}
@optional {fields: any, exclude_fields: any, count: any, cursor: any, created_before: any, created_since: any, updated_before: any, updated_since: any, sort_field: any, sort_dir: any}
@returns(200)

@endpoint POST /audiences/{audience_id}/contacts
@required {body: map, audience_id: any}
@optional {merge_field_validation_mode: any, data_mode: any}
@returns(200)

@endpoint GET /audiences/{audience_id}/contacts/{contact_id}
@required {audience_id: any, contact_id: any}
@optional {fields: any, exclude_fields: any}
@returns(200)

@endpoint PATCH /audiences/{audience_id}/contacts/{contact_id}
@required {body: map, audience_id: any, contact_id: any}
@optional {merge_field_validation_mode: any, data_mode: any}
@returns(200)

@endpoint POST /audiences/{audience_id}/contacts/{contact_id}/actions/archive
@required {audience_id: any, contact_id: any}
@returns(204)

@endpoint POST /audiences/{audience_id}/contacts/{contact_id}/actions/forget
@required {audience_id: any, contact_id: any}
@returns(204)

@endgroup

@group authorized-apps
@endpoint GET /authorized-apps
@optional {fields: any, exclude_fields: any, count: any, offset: any}
@returns(200)

@endpoint GET /authorized-apps/{app_id}
@required {app_id: any}
@optional {fields: any, exclude_fields: any}
@returns(200)

@endgroup

@group automations
@endpoint GET /automations
@optional {count: any, offset: any, fields: any, exclude_fields: any, before_create_time: any, since_create_time: any, before_start_time: any, since_start_time: any, status: any}
@returns(200)

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

@endpoint GET /automations/{workflow_id}
@required {workflow_id: any}
@optional {fields: any, exclude_fields: any}
@returns(200)

@endpoint POST /automations/{workflow_id}/actions/pause-all-emails
@required {workflow_id: any}
@returns(204)

@endpoint POST /automations/{workflow_id}/actions/start-all-emails
@required {workflow_id: any}
@returns(204)

@endpoint POST /automations/{workflow_id}/actions/archive
@required {workflow_id: any}
@returns(204)

@endpoint GET /automations/{workflow_id}/emails
@required {workflow_id: any}
@returns(200)

@endpoint GET /automations/{workflow_id}/emails/{workflow_email_id}
@required {workflow_id: any, workflow_email_id: any}
@returns(200)

@endpoint DELETE /automations/{workflow_id}/emails/{workflow_email_id}
@required {workflow_id: any, workflow_email_id: any}
@returns(204)

@endpoint PATCH /automations/{workflow_id}/emails/{workflow_email_id}
@required {workflow_id: any, workflow_email_id: any, body: map}
@returns(200)

@endpoint GET /automations/{workflow_id}/emails/{workflow_email_id}/queue
@required {workflow_id: any, workflow_email_id: any}
@returns(200)

@endpoint POST /automations/{workflow_id}/emails/{workflow_email_id}/queue
@required {workflow_id: any, workflow_email_id: any, body: map}
@returns(200)

@endpoint GET /automations/{workflow_id}/emails/{workflow_email_id}/queue/{subscriber_hash}
@required {workflow_id: any, workflow_email_id: any, subscriber_hash: any}
@returns(200)

@endpoint POST /automations/{workflow_id}/emails/{workflow_email_id}/actions/pause
@required {workflow_id: any, workflow_email_id: any}
@returns(204)

@endpoint POST /automations/{workflow_id}/emails/{workflow_email_id}/actions/start
@required {workflow_id: any, workflow_email_id: any}
@returns(204)

@endpoint GET /automations/{workflow_id}/removed-subscribers
@required {workflow_id: any}
@returns(200)

@endpoint POST /automations/{workflow_id}/removed-subscribers
@required {workflow_id: any, body: map}
@returns(200)

@endpoint GET /automations/{workflow_id}/removed-subscribers/{subscriber_hash}
@required {workflow_id: any, subscriber_hash: any}
@returns(200)

@endgroup

@group batches
@endpoint GET /batches
@optional {fields: any, exclude_fields: any, count: any, offset: any}
@returns(200)

@endpoint POST /batches
@required {body: map}
@returns(200)

@endpoint GET /batches/{batch_id}
@required {batch_id: any}
@optional {fields: any, exclude_fields: any}
@returns(200)

@endpoint DELETE /batches/{batch_id}
@required {batch_id: any}
@returns(204)

@endgroup

@group batch-webhooks
@endpoint GET /batch-webhooks
@optional {fields: any, exclude_fields: any, count: any, offset: any}
@returns(200)

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

@endpoint GET /batch-webhooks/{batch_webhook_id}
@required {batch_webhook_id: any}
@optional {fields: any, exclude_fields: any}
@returns(200)

@endpoint PATCH /batch-webhooks/{batch_webhook_id}
@required {batch_webhook_id: any, body: map}
@returns(200)

@endpoint DELETE /batch-webhooks/{batch_webhook_id}
@required {batch_webhook_id: any}
@returns(204)

@endgroup

@group template-folders
@endpoint GET /template-folders
@optional {fields: any, exclude_fields: any, count: any, offset: any}
@returns(200)

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

@endpoint GET /template-folders/{folder_id}
@required {folder_id: any}
@optional {fields: any, exclude_fields: any}
@returns(200)

@endpoint PATCH /template-folders/{folder_id}
@required {folder_id: any, body: map}
@returns(200)

@endpoint DELETE /template-folders/{folder_id}
@required {folder_id: any}
@returns(204)

@endgroup

@group campaign-folders
@endpoint GET /campaign-folders
@optional {fields: any, exclude_fields: any, count: any, offset: any}
@returns(200)

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

@endpoint GET /campaign-folders/{folder_id}
@required {folder_id: any}
@optional {fields: any, exclude_fields: any}
@returns(200)

@endpoint PATCH /campaign-folders/{folder_id}
@required {folder_id: any, body: map}
@returns(200)

@endpoint DELETE /campaign-folders/{folder_id}
@required {folder_id: any}
@returns(204)

@endgroup

@group campaigns
@endpoint GET /campaigns
@optional {fields: any, exclude_fields: any, count: any, offset: any, type: any, status: any, before_send_time: any, since_send_time: any, before_create_time: any, since_create_time: any, list_id: any, folder_id: any, member_id: any, sort_field: any, sort_dir: any, include_resend_shortcut_eligibility: any}
@returns(200)

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

@endpoint GET /campaigns/{campaign_id}
@required {campaign_id: any}
@optional {fields: any, exclude_fields: any, include_resend_shortcut_eligibility: any, include_resend_shortcut_usage: any}
@returns(200)

@endpoint PATCH /campaigns/{campaign_id}
@required {campaign_id: any, body: map}
@returns(200)

@endpoint DELETE /campaigns/{campaign_id}
@required {campaign_id: any}
@returns(204)

@endpoint POST /campaigns/{campaign_id}/actions/cancel-send
@required {campaign_id: any}
@returns(204)

@endpoint POST /campaigns/{campaign_id}/actions/replicate
@required {campaign_id: any}
@returns(200)

@endpoint POST /campaigns/{campaign_id}/actions/send
@required {campaign_id: any}
@returns(204)

@endpoint POST /campaigns/{campaign_id}/actions/schedule
@required {campaign_id: any, body: map}
@returns(204)

@endpoint POST /campaigns/{campaign_id}/actions/unschedule
@required {campaign_id: any}
@returns(204)

@endpoint POST /campaigns/{campaign_id}/actions/test
@required {campaign_id: any, body: map}
@returns(204)

@endpoint POST /campaigns/{campaign_id}/actions/pause
@required {campaign_id: any}
@returns(204)

@endpoint POST /campaigns/{campaign_id}/actions/resume
@required {campaign_id: any}
@returns(204)

@endpoint POST /campaigns/{campaign_id}/actions/create-resend
@required {campaign_id: any}
@optional {body: map}
@returns(200)

@endpoint GET /campaigns/{campaign_id}/content
@required {campaign_id: any}
@optional {fields: any, exclude_fields: any}
@returns(200)

@endpoint PUT /campaigns/{campaign_id}/content
@required {campaign_id: any, body: map}
@returns(200)

@endpoint GET /campaigns/{campaign_id}/feedback
@required {campaign_id: any}
@optional {fields: any, exclude_fields: any}
@returns(200)

@endpoint POST /campaigns/{campaign_id}/feedback
@required {campaign_id: any, body: map}
@returns(200)

@endpoint GET /campaigns/{campaign_id}/feedback/{feedback_id}
@required {campaign_id: any, feedback_id: any}
@optional {fields: any, exclude_fields: any}
@returns(200)

@endpoint PATCH /campaigns/{campaign_id}/feedback/{feedback_id}
@required {campaign_id: any, feedback_id: any, body: map}
@returns(200)

@endpoint DELETE /campaigns/{campaign_id}/feedback/{feedback_id}
@required {campaign_id: any, feedback_id: any}
@returns(204)

@endpoint GET /campaigns/{campaign_id}/send-checklist
@required {campaign_id: any}
@optional {fields: any, exclude_fields: any}
@returns(200)

@endgroup

@group connected-sites
@endpoint GET /connected-sites
@optional {fields: any, exclude_fields: any, count: any, offset: any}
@returns(200)

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

@endpoint GET /connected-sites/{connected_site_id}
@required {connected_site_id: any}
@optional {fields: any, exclude_fields: any}
@returns(200)

@endpoint DELETE /connected-sites/{connected_site_id}
@required {connected_site_id: any}
@returns(204)

@endpoint POST /connected-sites/{connected_site_id}/actions/verify-script-installation
@required {connected_site_id: any}
@returns(204)

@endgroup

@group conversations
@endpoint GET /conversations
@optional {fields: any, exclude_fields: any, count: any, offset: any, has_unread_messages: any, list_id: any, campaign_id: any}
@returns(200)

@endpoint GET /conversations/{conversation_id}
@required {conversation_id: any}
@optional {fields: any, exclude_fields: any}
@returns(200)

@endpoint GET /conversations/{conversation_id}/messages
@required {conversation_id: any}
@optional {fields: any, exclude_fields: any, is_read: any, before_timestamp: any, since_timestamp: any}
@returns(200)

@endpoint GET /conversations/{conversation_id}/messages/{message_id}
@required {conversation_id: any, message_id: any}
@optional {fields: any, exclude_fields: any}
@returns(200)

@endgroup

@group customer-journeys
@endpoint POST /customer-journeys/journeys/{journey_id}/steps/{step_id}/actions/trigger
@required {journey_id: any, step_id: any, body: map}
@returns(204)

@endgroup

@group file-manager
@endpoint GET /file-manager/files
@optional {fields: any, exclude_fields: any, count: any, offset: any, type: any, created_by: any, before_created_at: any, since_created_at: any, sort_field: any, sort_dir: any}
@returns(200)

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

@endpoint GET /file-manager/files/{file_id}
@required {file_id: any}
@optional {fields: any, exclude_fields: any}
@returns(200)

@endpoint PATCH /file-manager/files/{file_id}
@required {file_id: any, body: map}
@returns(200)

@endpoint DELETE /file-manager/files/{file_id}
@required {file_id: any}
@returns(204)

@endpoint GET /file-manager/folders
@optional {fields: any, exclude_fields: any, count: any, offset: any, created_by: any, before_created_at: any, since_created_at: any}
@returns(200)

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

@endpoint GET /file-manager/folders/{folder_id}
@required {folder_id: any}
@optional {fields: any, exclude_fields: any}
@returns(200)

@endpoint PATCH /file-manager/folders/{folder_id}
@required {folder_id: any, body: map}
@returns(200)

@endpoint DELETE /file-manager/folders/{folder_id}
@required {folder_id: any}
@returns(204)

@endpoint GET /file-manager/folders/{folder_id}/files
@required {folder_id: any}
@optional {fields: any, exclude_fields: any, count: any, offset: any, type: any, created_by: any, before_created_at: any, since_created_at: any, sort_field: any, sort_dir: any}
@returns(200)

@endgroup

@group lists
@endpoint GET /lists
@optional {fields: any, exclude_fields: any, count: any, offset: any, before_date_created: any, since_date_created: any, before_campaign_last_sent: any, since_campaign_last_sent: any, email: any, sort_field: any, sort_dir: any, has_ecommerce_store: any, include_total_contacts: any}
@returns(200)

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

@endpoint GET /lists/{list_id}
@required {list_id: any}
@optional {fields: any, exclude_fields: any, include_total_contacts: any}
@returns(200)

@endpoint PATCH /lists/{list_id}
@required {list_id: any, body: map}
@returns(200)

@endpoint DELETE /lists/{list_id}
@required {list_id: any}
@returns(204)

@endpoint POST /lists/{list_id}
@required {list_id: any, body: map}
@optional {skip_merge_validation: any, skip_duplicate_check: any}
@returns(200)

@endpoint GET /lists/{list_id}/abuse-reports
@required {list_id: any}
@optional {fields: any, exclude_fields: any, count: any, offset: any}
@returns(200)

@endpoint GET /lists/{list_id}/abuse-reports/{report_id}
@required {list_id: any, report_id: any}
@optional {fields: any, exclude_fields: any, count: any, offset: any}
@returns(200)

@endpoint GET /lists/{list_id}/activity
@required {list_id: any}
@optional {count: any, offset: any, fields: any, exclude_fields: any}
@returns(200)

@endpoint GET /lists/{list_id}/clients
@required {list_id: any}
@optional {fields: any, exclude_fields: any}
@returns(200)

@endpoint GET /lists/{list_id}/growth-history
@required {list_id: any}
@optional {fields: any, exclude_fields: any, count: any, offset: any, sort_field: any, sort_dir: any}
@returns(200)

@endpoint GET /lists/{list_id}/growth-history/{month}
@required {list_id: any, month: any}
@optional {fields: any, exclude_fields: any}
@returns(200)

@endpoint GET /lists/{list_id}/interest-categories
@required {list_id: any}
@optional {fields: any, exclude_fields: any, count: any, offset: any, type: any}
@returns(200)

@endpoint POST /lists/{list_id}/interest-categories
@required {list_id: any, body: map}
@returns(200)

@endpoint GET /lists/{list_id}/interest-categories/{interest_category_id}
@required {list_id: any, interest_category_id: any}
@optional {fields: any, exclude_fields: any}
@returns(200)

@endpoint PATCH /lists/{list_id}/interest-categories/{interest_category_id}
@required {list_id: any, interest_category_id: any, body: map}
@returns(200)

@endpoint DELETE /lists/{list_id}/interest-categories/{interest_category_id}
@required {list_id: any, interest_category_id: any}
@returns(204)

@endpoint GET /lists/{list_id}/interest-categories/{interest_category_id}/interests
@required {list_id: any, interest_category_id: any}
@optional {fields: any, exclude_fields: any, count: any, offset: any}
@returns(200)

@endpoint POST /lists/{list_id}/interest-categories/{interest_category_id}/interests
@required {list_id: any, interest_category_id: any, body: map}
@returns(200)

@endpoint GET /lists/{list_id}/interest-categories/{interest_category_id}/interests/{interest_id}
@required {list_id: any, interest_category_id: any, interest_id: any}
@optional {fields: any, exclude_fields: any}
@returns(200)

@endpoint PATCH /lists/{list_id}/interest-categories/{interest_category_id}/interests/{interest_id}
@required {list_id: any, interest_category_id: any, interest_id: any, body: map}
@returns(200)

@endpoint DELETE /lists/{list_id}/interest-categories/{interest_category_id}/interests/{interest_id}
@required {list_id: any, interest_category_id: any, interest_id: any}
@returns(204)

@endpoint GET /lists/{list_id}/segments
@required {list_id: any}
@optional {fields: any, exclude_fields: any, count: any, offset: any, type: any, since_created_at: any, before_created_at: any, include_cleaned: any, include_transactional: any, include_unsubscribed: any, since_updated_at: any, before_updated_at: any}
@returns(200)

@endpoint POST /lists/{list_id}/segments
@required {list_id: any, body: map}
@returns(200)

@endpoint GET /lists/{list_id}/segments/{segment_id}
@required {list_id: any, segment_id: any}
@optional {fields: any, exclude_fields: any, include_cleaned: any, include_transactional: any, include_unsubscribed: any}
@returns(200)

@endpoint DELETE /lists/{list_id}/segments/{segment_id}
@required {list_id: any, segment_id: any}
@returns(204)

@endpoint PATCH /lists/{list_id}/segments/{segment_id}
@required {list_id: any, segment_id: any, body: map}
@returns(200)

@endpoint POST /lists/{list_id}/segments/{segment_id}
@required {body: map, list_id: any, segment_id: any}
@returns(200)

@endpoint GET /lists/{list_id}/segments/{segment_id}/members
@required {list_id: any, segment_id: any}
@optional {fields: any, exclude_fields: any, count: any, offset: any, include_cleaned: any, include_transactional: any, include_unsubscribed: any}
@returns(200)

@endpoint POST /lists/{list_id}/segments/{segment_id}/members
@required {list_id: any, segment_id: any, body: map}
@returns(200)

@endpoint DELETE /lists/{list_id}/segments/{segment_id}/members/{subscriber_hash}
@required {list_id: any, segment_id: any, subscriber_hash: any}
@returns(204)

@endpoint GET /lists/{list_id}/tag-search
@required {list_id: any}
@optional {name: any}
@returns(200)

@endpoint GET /lists/{list_id}/members
@required {list_id: any}
@optional {fields: any, exclude_fields: any, count: any, offset: any, email_type: any, status: any, since_timestamp_opt: any, before_timestamp_opt: any, since_last_changed: any, before_last_changed: any, unique_email_id: any, vip_only: any, interest_category_id: any, interest_ids: any, interest_match: any, sort_field: any, sort_dir: any, since_last_campaign: any, unsubscribed_since: any}
@returns(200)

@endpoint POST /lists/{list_id}/members
@required {list_id: any, body: map}
@optional {skip_merge_validation: any}
@returns(200)

@endpoint GET /lists/{list_id}/members/{subscriber_hash}
@required {list_id: any, subscriber_hash: any}
@optional {fields: any, exclude_fields: any}
@returns(200)

@endpoint PUT /lists/{list_id}/members/{subscriber_hash}
@required {list_id: any, subscriber_hash: any, body: map}
@optional {skip_merge_validation: any}
@returns(200)

@endpoint PATCH /lists/{list_id}/members/{subscriber_hash}
@required {list_id: any, subscriber_hash: any, body: map}
@optional {skip_merge_validation: any}
@returns(200)

@endpoint DELETE /lists/{list_id}/members/{subscriber_hash}
@required {list_id: any, subscriber_hash: any}
@returns(204)

@endpoint GET /lists/{list_id}/members/{subscriber_hash}/activity
@required {list_id: any, subscriber_hash: any}
@optional {fields: any, exclude_fields: any, action: any}
@returns(200)

@endpoint GET /lists/{list_id}/members/{subscriber_hash}/activity-feed
@required {list_id: any, subscriber_hash: any}
@optional {fields: any, exclude_fields: any, count: any, offset: any, activity_filters: any}
@returns(200)

@endpoint GET /lists/{list_id}/members/{subscriber_hash}/tags
@required {list_id: any, subscriber_hash: any}
@optional {fields: any, exclude_fields: any, count: any, offset: any}
@returns(200)

@endpoint POST /lists/{list_id}/members/{subscriber_hash}/tags
@required {list_id: any, subscriber_hash: any, body: map}
@returns(204)

@endpoint GET /lists/{list_id}/members/{subscriber_hash}/events
@required {list_id: any, subscriber_hash: any}
@optional {count: any, offset: any, fields: any, exclude_fields: any}
@returns(200)

@endpoint POST /lists/{list_id}/members/{subscriber_hash}/events
@required {list_id: any, subscriber_hash: any, body: map}
@returns(204)

@endpoint GET /lists/{list_id}/members/{subscriber_hash}/goals
@required {list_id: any, subscriber_hash: any}
@optional {fields: any, exclude_fields: any}
@returns(200)

@endpoint GET /lists/{list_id}/members/{subscriber_hash}/notes
@required {list_id: any, subscriber_hash: any}
@optional {sort_field: any, sort_dir: any, fields: any, exclude_fields: any, count: any, offset: any}
@returns(200)

@endpoint POST /lists/{list_id}/members/{subscriber_hash}/notes
@required {list_id: any, subscriber_hash: any, body: map}
@returns(200)

@endpoint GET /lists/{list_id}/members/{subscriber_hash}/notes/{note_id}
@required {list_id: any, subscriber_hash: any, note_id: any}
@optional {fields: any, exclude_fields: any}
@returns(200)

@endpoint PATCH /lists/{list_id}/members/{subscriber_hash}/notes/{note_id}
@required {list_id: any, subscriber_hash: any, note_id: any, body: map}
@returns(200)

@endpoint DELETE /lists/{list_id}/members/{subscriber_hash}/notes/{note_id}
@required {list_id: any, subscriber_hash: any, note_id: any}
@returns(204)

@endpoint POST /lists/{list_id}/members/{subscriber_hash}/actions/delete-permanent
@required {list_id: any, subscriber_hash: any}
@returns(204)

@endpoint GET /lists/{list_id}/merge-fields
@required {list_id: any}
@optional {fields: any, exclude_fields: any, count: any, offset: any, type: any, required: any}
@returns(200)

@endpoint POST /lists/{list_id}/merge-fields
@required {list_id: any, body: map}
@returns(200)

@endpoint GET /lists/{list_id}/merge-fields/{merge_id}
@required {list_id: any, merge_id: any}
@optional {exclude_fields: any, fields: any}
@returns(200)

@endpoint PATCH /lists/{list_id}/merge-fields/{merge_id}
@required {list_id: any, merge_id: any, body: map}
@returns(200)

@endpoint DELETE /lists/{list_id}/merge-fields/{merge_id}
@required {list_id: any, merge_id: any}
@returns(204)

@endpoint GET /lists/{list_id}/webhooks
@required {list_id: any}
@returns(200)

@endpoint POST /lists/{list_id}/webhooks
@required {list_id: any, body: map}
@returns(200)

@endpoint GET /lists/{list_id}/webhooks/{webhook_id}
@required {list_id: any, webhook_id: any}
@returns(200)

@endpoint DELETE /lists/{list_id}/webhooks/{webhook_id}
@required {list_id: any, webhook_id: any}
@returns(204)

@endpoint PATCH /lists/{list_id}/webhooks/{webhook_id}
@required {list_id: any, webhook_id: any, body: map}
@returns(200)

@endpoint GET /lists/{list_id}/signup-forms
@required {list_id: any}
@returns(200)

@endpoint POST /lists/{list_id}/signup-forms
@required {list_id: any, body: map}
@returns(200)

@endpoint GET /lists/{list_id}/locations
@required {list_id: any}
@optional {fields: any, exclude_fields: any}
@returns(200)

@endpoint GET /lists/{list_id}/surveys
@required {list_id: any}
@returns(200)

@endpoint GET /lists/{list_id}/surveys/{survey_id}
@required {list_id: any, survey_id: any}
@returns(200)

@endpoint POST /lists/{list_id}/surveys/{survey_id}/actions/publish
@required {list_id: any, survey_id: any}
@returns(200)

@endpoint POST /lists/{list_id}/surveys/{survey_id}/actions/unpublish
@required {list_id: any, survey_id: any}
@returns(200)

@endpoint POST /lists/{list_id}/surveys/{survey_id}/actions/create-email
@required {list_id: any, survey_id: any}
@returns(200)

@endgroup

@group landing-pages
@endpoint GET /landing-pages
@optional {sort_dir: any, sort_field: any, fields: any, exclude_fields: any, count: any}
@returns(200)

@endpoint POST /landing-pages
@required {body: map}
@optional {use_default_list: any}
@returns(200)

@endpoint GET /landing-pages/{page_id}
@required {page_id: any}
@optional {fields: any, exclude_fields: any}
@returns(200)

@endpoint PATCH /landing-pages/{page_id}
@required {page_id: any, body: map}
@returns(200)

@endpoint DELETE /landing-pages/{page_id}
@required {page_id: any}
@returns(204)

@endpoint POST /landing-pages/{page_id}/actions/publish
@required {page_id: any}
@returns(204)

@endpoint POST /landing-pages/{page_id}/actions/unpublish
@required {page_id: any}
@returns(204)

@endpoint GET /landing-pages/{page_id}/content
@required {page_id: any}
@optional {fields: any, exclude_fields: any}
@returns(200)

@endgroup

@group reports
@endpoint GET /reports
@optional {fields: any, exclude_fields: any, count: any, offset: any, type: any, before_send_time: any, since_send_time: any}
@returns(200)

@endpoint GET /reports/{campaign_id}
@required {campaign_id: any}
@optional {fields: any, exclude_fields: any}
@returns(200)

@endpoint GET /reports/{campaign_id}/abuse-reports
@required {campaign_id: any}
@optional {fields: any, exclude_fields: any}
@returns(200)

@endpoint GET /reports/{campaign_id}/abuse-reports/{report_id}
@required {campaign_id: any, report_id: any}
@optional {fields: any, exclude_fields: any}
@returns(200)

@endpoint GET /reports/{campaign_id}/advice
@required {campaign_id: any}
@optional {fields: any, exclude_fields: any}
@returns(200)

@endpoint GET /reports/{campaign_id}/click-details
@required {campaign_id: any}
@optional {fields: any, exclude_fields: any, count: any, offset: any, sort_field: any, sort_dir: any}
@returns(200)

@endpoint GET /reports/{campaign_id}/click-details/{link_id}
@required {campaign_id: any, link_id: any}
@optional {fields: any, exclude_fields: any}
@returns(200)

@endpoint GET /reports/{campaign_id}/click-details/{link_id}/members
@required {campaign_id: any, link_id: any}
@optional {fields: any, exclude_fields: any, count: any, offset: any}
@returns(200)

@endpoint GET /reports/{campaign_id}/click-details/{link_id}/members/{subscriber_hash}
@required {campaign_id: any, link_id: any, subscriber_hash: any}
@optional {fields: any, exclude_fields: any}
@returns(200)

@endpoint GET /reports/{campaign_id}/open-details
@required {campaign_id: any}
@optional {fields: any, exclude_fields: any, count: any, offset: any, since: any, sort_field: any, sort_dir: any}
@returns(200)

@endpoint GET /reports/{campaign_id}/open-details/{subscriber_hash}
@required {campaign_id: any, subscriber_hash: any}
@optional {fields: any, exclude_fields: any}
@returns(200)

@endpoint GET /reports/{campaign_id}/domain-performance
@required {campaign_id: any}
@optional {fields: any, exclude_fields: any}
@returns(200)

@endpoint GET /reports/{campaign_id}/eepurl
@required {campaign_id: any}
@optional {fields: any, exclude_fields: any}
@returns(200)

@endpoint GET /reports/{campaign_id}/email-activity
@required {campaign_id: any}
@optional {fields: any, exclude_fields: any, count: any, offset: any, since: any}
@returns(200)

@endpoint GET /reports/{campaign_id}/email-activity/{subscriber_hash}
@required {campaign_id: any, subscriber_hash: any}
@optional {fields: any, exclude_fields: any, since: any}
@returns(200)

@endpoint GET /reports/{campaign_id}/locations
@required {campaign_id: any}
@optional {fields: any, exclude_fields: any, count: any, offset: any}
@returns(200)

@endpoint GET /reports/{campaign_id}/sent-to
@required {campaign_id: any}
@optional {fields: any, exclude_fields: any, count: any, offset: any}
@returns(200)

@endpoint GET /reports/{campaign_id}/sent-to/{subscriber_hash}
@required {campaign_id: any, subscriber_hash: any}
@optional {fields: any, exclude_fields: any}
@returns(200)

@endpoint GET /reports/{campaign_id}/sub-reports
@required {campaign_id: any}
@optional {fields: any, exclude_fields: any}
@returns(200)

@endpoint GET /reports/{campaign_id}/unsubscribed
@required {campaign_id: any}
@optional {fields: any, exclude_fields: any, count: any, offset: any}
@returns(200)

@endpoint GET /reports/{campaign_id}/unsubscribed/{subscriber_hash}
@required {campaign_id: any, subscriber_hash: any}
@optional {fields: any, exclude_fields: any}
@returns(200)

@endpoint GET /reports/{campaign_id}/ecommerce-product-activity
@required {campaign_id: any}
@optional {fields: any, exclude_fields: any, count: any, offset: any, sort_field: any}
@returns(200)

@endgroup

@group templates
@endpoint GET /templates
@optional {fields: any, exclude_fields: any, count: any, offset: any, created_by: any, since_date_created: any, before_date_created: any, type: any, category: any, folder_id: any, sort_field: any, content_type: any, sort_dir: any}
@returns(200)

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

@endpoint GET /templates/{template_id}
@required {template_id: any}
@optional {fields: any, exclude_fields: any}
@returns(200)

@endpoint PATCH /templates/{template_id}
@required {template_id: any, body: map}
@returns(200)

@endpoint DELETE /templates/{template_id}
@required {template_id: any}
@returns(204)

@endpoint GET /templates/{template_id}/default-content
@required {template_id: any}
@optional {fields: any, exclude_fields: any}
@returns(200)

@endgroup

@group ecommerce
@endpoint GET /ecommerce/orders
@optional {fields: any, exclude_fields: any, count: any, offset: any, campaign_id: any, outreach_id: any, customer_id: any, has_outreach: any}
@returns(200)

@endpoint GET /ecommerce/stores
@optional {fields: any, exclude_fields: any, count: any, offset: any}
@returns(200)

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

@endpoint GET /ecommerce/stores/{store_id}
@required {store_id: any}
@optional {fields: any, exclude_fields: any}
@returns(200)

@endpoint PATCH /ecommerce/stores/{store_id}
@required {store_id: any, body: map}
@returns(200)

@endpoint DELETE /ecommerce/stores/{store_id}
@required {store_id: any}
@returns(204)

@endpoint GET /ecommerce/stores/{store_id}/carts
@required {store_id: any}
@optional {fields: any, exclude_fields: any, count: any, offset: any}
@returns(200)

@endpoint POST /ecommerce/stores/{store_id}/carts
@required {store_id: any, body: map}
@returns(200)

@endpoint GET /ecommerce/stores/{store_id}/carts/{cart_id}
@required {store_id: any, cart_id: any}
@optional {fields: any, exclude_fields: any}
@returns(200)

@endpoint PATCH /ecommerce/stores/{store_id}/carts/{cart_id}
@required {store_id: any, cart_id: any, body: map}
@returns(200)

@endpoint DELETE /ecommerce/stores/{store_id}/carts/{cart_id}
@required {store_id: any, cart_id: any}
@returns(204)

@endpoint GET /ecommerce/stores/{store_id}/carts/{cart_id}/lines
@required {store_id: any, cart_id: any}
@optional {fields: any, exclude_fields: any, count: any, offset: any}
@returns(200)

@endpoint POST /ecommerce/stores/{store_id}/carts/{cart_id}/lines
@required {store_id: any, cart_id: any, body: map}
@returns(200)

@endpoint GET /ecommerce/stores/{store_id}/carts/{cart_id}/lines/{line_id}
@required {store_id: any, cart_id: any, line_id: any}
@optional {fields: any, exclude_fields: any}
@returns(200)

@endpoint PATCH /ecommerce/stores/{store_id}/carts/{cart_id}/lines/{line_id}
@required {store_id: any, cart_id: any, line_id: any, body: map}
@returns(200)

@endpoint DELETE /ecommerce/stores/{store_id}/carts/{cart_id}/lines/{line_id}
@required {store_id: any, cart_id: any, line_id: any}
@returns(204)

@endpoint GET /ecommerce/stores/{store_id}/customers
@required {store_id: any}
@optional {fields: any, exclude_fields: any, count: any, offset: any, email_address: any}
@returns(200)

@endpoint POST /ecommerce/stores/{store_id}/customers
@required {store_id: any, body: map}
@returns(200)

@endpoint GET /ecommerce/stores/{store_id}/customers/{customer_id}
@required {store_id: any, customer_id: any}
@optional {fields: any, exclude_fields: any}
@returns(200)

@endpoint PUT /ecommerce/stores/{store_id}/customers/{customer_id}
@required {store_id: any, customer_id: any, body: map}
@returns(200)

@endpoint PATCH /ecommerce/stores/{store_id}/customers/{customer_id}
@required {store_id: any, customer_id: any, body: map}
@returns(200)

@endpoint DELETE /ecommerce/stores/{store_id}/customers/{customer_id}
@required {store_id: any, customer_id: any}
@returns(204)

@endpoint GET /ecommerce/stores/{store_id}/promo-rules
@required {store_id: any}
@optional {fields: any, exclude_fields: any, count: any, offset: any}
@returns(200)

@endpoint POST /ecommerce/stores/{store_id}/promo-rules
@required {store_id: any, body: map}
@returns(200)

@endpoint GET /ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}
@required {store_id: any, promo_rule_id: any}
@optional {fields: any, exclude_fields: any}
@returns(200)

@endpoint PATCH /ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}
@required {store_id: any, promo_rule_id: any, body: map}
@returns(200)

@endpoint DELETE /ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}
@required {store_id: any, promo_rule_id: any}
@returns(204)

@endpoint GET /ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}/promo-codes
@required {promo_rule_id: any, store_id: any}
@optional {fields: any, exclude_fields: any, count: any, offset: any}
@returns(200)

@endpoint POST /ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}/promo-codes
@required {store_id: any, promo_rule_id: any, body: map}
@returns(200)

@endpoint GET /ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}/promo-codes/{promo_code_id}
@required {store_id: any, promo_rule_id: any, promo_code_id: any}
@optional {fields: any, exclude_fields: any}
@returns(200)

@endpoint PATCH /ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}/promo-codes/{promo_code_id}
@required {store_id: any, promo_rule_id: any, promo_code_id: any, body: map}
@returns(200)

@endpoint DELETE /ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}/promo-codes/{promo_code_id}
@required {store_id: any, promo_rule_id: any, promo_code_id: any}
@returns(204)

@endpoint GET /ecommerce/stores/{store_id}/orders
@required {store_id: any}
@optional {fields: any, exclude_fields: any, count: any, offset: any, customer_id: any, has_outreach: any, campaign_id: any, outreach_id: any}
@returns(200)

@endpoint POST /ecommerce/stores/{store_id}/orders
@required {store_id: any, body: map}
@returns(200)

@endpoint GET /ecommerce/stores/{store_id}/orders/{order_id}
@required {store_id: any, order_id: any}
@optional {fields: any, exclude_fields: any}
@returns(200)

@endpoint PUT /ecommerce/stores/{store_id}/orders/{order_id}
@required {store_id: any, order_id: any, body: map}
@returns(200)

@endpoint PATCH /ecommerce/stores/{store_id}/orders/{order_id}
@required {store_id: any, order_id: any, body: map}
@returns(200)

@endpoint DELETE /ecommerce/stores/{store_id}/orders/{order_id}
@required {store_id: any, order_id: any}
@returns(204)

@endpoint GET /ecommerce/stores/{store_id}/orders/{order_id}/lines
@required {store_id: any, order_id: any}
@optional {fields: any, exclude_fields: any, count: any, offset: any}
@returns(200)

@endpoint POST /ecommerce/stores/{store_id}/orders/{order_id}/lines
@required {store_id: any, order_id: any, body: map}
@returns(200)

@endpoint GET /ecommerce/stores/{store_id}/orders/{order_id}/lines/{line_id}
@required {store_id: any, order_id: any, line_id: any}
@optional {fields: any, exclude_fields: any}
@returns(200)

@endpoint PATCH /ecommerce/stores/{store_id}/orders/{order_id}/lines/{line_id}
@required {store_id: any, order_id: any, line_id: any, body: map}
@returns(200)

@endpoint DELETE /ecommerce/stores/{store_id}/orders/{order_id}/lines/{line_id}
@required {store_id: any, order_id: any, line_id: any}
@returns(204)

@endpoint GET /ecommerce/stores/{store_id}/products
@required {store_id: any}
@optional {fields: any, exclude_fields: any, count: any, offset: any}
@returns(200)

@endpoint POST /ecommerce/stores/{store_id}/products
@required {store_id: any, body: map}
@returns(200)

@endpoint GET /ecommerce/stores/{store_id}/products/{product_id}
@required {store_id: any, product_id: any}
@optional {fields: any, exclude_fields: any}
@returns(200)

@endpoint PATCH /ecommerce/stores/{store_id}/products/{product_id}
@required {store_id: any, product_id: any, body: map}
@returns(200)

@endpoint PUT /ecommerce/stores/{store_id}/products/{product_id}
@required {store_id: any, product_id: any, body: map}
@returns(200)

@endpoint DELETE /ecommerce/stores/{store_id}/products/{product_id}
@required {store_id: any, product_id: any}
@returns(204)

@endpoint GET /ecommerce/stores/{store_id}/products/{product_id}/variants
@required {store_id: any, product_id: any}
@optional {fields: any, exclude_fields: any, count: any, offset: any}
@returns(200)

@endpoint POST /ecommerce/stores/{store_id}/products/{product_id}/variants
@required {store_id: any, product_id: any, body: map}
@returns(200)

@endpoint GET /ecommerce/stores/{store_id}/products/{product_id}/variants/{variant_id}
@required {store_id: any, product_id: any, variant_id: any}
@optional {fields: any, exclude_fields: any}
@returns(200)

@endpoint PUT /ecommerce/stores/{store_id}/products/{product_id}/variants/{variant_id}
@required {store_id: any, product_id: any, variant_id: any, body: map}
@returns(200)

@endpoint PATCH /ecommerce/stores/{store_id}/products/{product_id}/variants/{variant_id}
@required {store_id: any, product_id: any, variant_id: any, body: map}
@returns(200)

@endpoint DELETE /ecommerce/stores/{store_id}/products/{product_id}/variants/{variant_id}
@required {store_id: any, product_id: any, variant_id: any}
@returns(204)

@endpoint GET /ecommerce/stores/{store_id}/products/{product_id}/images
@required {store_id: any, product_id: any}
@optional {fields: any, exclude_fields: any, count: any, offset: any}
@returns(200)

@endpoint POST /ecommerce/stores/{store_id}/products/{product_id}/images
@required {store_id: any, product_id: any, body: map}
@returns(200)

@endpoint GET /ecommerce/stores/{store_id}/products/{product_id}/images/{image_id}
@required {store_id: any, product_id: any, image_id: any}
@optional {fields: any, exclude_fields: any}
@returns(200)

@endpoint PATCH /ecommerce/stores/{store_id}/products/{product_id}/images/{image_id}
@required {store_id: any, product_id: any, image_id: any, body: map}
@returns(200)

@endpoint DELETE /ecommerce/stores/{store_id}/products/{product_id}/images/{image_id}
@required {store_id: any, product_id: any, image_id: any}
@returns(204)

@endgroup

@group search-campaigns
@endpoint GET /search-campaigns
@required {query: any}
@optional {fields: any, exclude_fields: any}
@returns(200)

@endgroup

@group search-members
@endpoint GET /search-members
@required {query: any}
@optional {fields: any, exclude_fields: any, list_id: any}
@returns(200)

@endgroup

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

@endgroup

@group facebook-ads
@endpoint GET /facebook-ads
@optional {fields: any, exclude_fields: any, count: any, offset: any, sort_field: any, sort_dir: any}
@returns(200)

@endpoint GET /facebook-ads/{outreach_id}
@required {outreach_id: any}
@optional {fields: any, exclude_fields: any}
@returns(200)

@endgroup

@group reporting
@endpoint GET /reporting/facebook-ads
@optional {fields: any, exclude_fields: any, count: any, offset: any, sort_field: any, sort_dir: any}
@returns(200)

@endpoint GET /reporting/facebook-ads/{outreach_id}
@required {outreach_id: any}
@optional {fields: any, exclude_fields: any}
@returns(200)

@endpoint GET /reporting/facebook-ads/{outreach_id}/ecommerce-product-activity
@required {outreach_id: any}
@optional {fields: any, exclude_fields: any, count: any, offset: any, sort_field: any}
@returns(200)

@endpoint GET /reporting/landing-pages/{outreach_id}
@required {outreach_id: any}
@optional {fields: any, exclude_fields: any}
@returns(200)

@endpoint GET /reporting/landing-pages
@optional {fields: any, exclude_fields: any, count: any, offset: any}
@returns(200)

@endpoint GET /reporting/surveys
@optional {fields: any, exclude_fields: any, count: any, offset: any}
@returns(200)

@endpoint GET /reporting/surveys/{survey_id}
@required {survey_id: any}
@optional {fields: any, exclude_fields: any}
@returns(200)

@endpoint GET /reporting/surveys/{survey_id}/questions
@required {survey_id: any}
@optional {fields: any, exclude_fields: any}
@returns(200)

@endpoint GET /reporting/surveys/{survey_id}/questions/{question_id}
@required {survey_id: any, question_id: any}
@optional {fields: any, exclude_fields: any}
@returns(200)

@endpoint GET /reporting/surveys/{survey_id}/questions/{question_id}/answers
@required {survey_id: any, question_id: any}
@optional {fields: any, exclude_fields: any, respondent_familiarity_is: any}
@returns(200)

@endpoint GET /reporting/surveys/{survey_id}/responses
@required {survey_id: any}
@optional {fields: any, exclude_fields: any, answered_question: any, chose_answer: any, respondent_familiarity_is: any}
@returns(200)

@endpoint GET /reporting/surveys/{survey_id}/responses/{response_id}
@required {survey_id: any, response_id: any}
@returns(200)

@endgroup

@group verified-domains
@endpoint GET /verified-domains/{domain_name}
@required {domain_name: any}
@returns(200)

@endpoint DELETE /verified-domains/{domain_name}
@required {domain_name: any}
@returns(204)

@endpoint POST /verified-domains/{domain_name}/actions/verify
@required {domain_name: any, body: map}
@returns(200)

@endpoint GET /verified-domains
@returns(200)

@endpoint POST /verified-domains
@required {body: map}
@returns(200)

@endgroup

@end