Skip to main content

Mailchimp

Automação de marketing por email (Mailchimp Marketing API) e envio transacional (Mailchimp Transactional/Mandrill).

Mailchimp Logo

Authentication​

This connector uses Token-based authentication.

info

Set up your connection in the Abstra Console before using it in your workflows.

How to use​

Using the Smart Chat​

Execute the action "CHOOSE_ONE_ACTION_BELOW" from my connector "YOUR_CONNECTOR_NAME" using the params "PARAMS_HERE".

Using the Web Editor​

from abstra.connectors import run_connection_action

result = run_connection_action(
  connection_name="your_connection_name",
  action_name="your_action_name",
  params={
    "param1": "value1",
    "param2": "value2"
  })

Available Actions​

This connector provides 399 actions:

ActionPurposeParameters
marketing/getGet links to all other resources available in the API.fields (string)
exclude_fields (string)
marketing/get_activity_feed_chimp_chatterReturn the Chimp Chatter for this account ordered by most recent.count (string)
offset (string)
marketing/get_account_exportsGet a list of account exports for a given account.fields (string)
exclude_fields (string)
count (string)
offset (string)
marketing/post_account_exportsCreate a new account export in your Mailchimp account.data: {
. include_stages (array)
. since_timestamp (string)
} (object) required
marketing/get_account_exports_by_export_idGet information about a specific account export.export_id (string) required
fields (string)
exclude_fields (string)
marketing/get_audiencesGet information about all audiences in the account.fields (string)
exclude_fields (string)
count (string)
offset (string)
marketing/get_audiences_by_audience_idGet information about a specific audience.audience_id (string) required
fields (string)
exclude_fields (string)
marketing/get_audiences_by_audience_id_contactsGet a list of omni-channel contacts for a given audience.audience_id (string) required
fields (string)
exclude_fields (string)
count (string)
cursor (string)
created_before (string)
created_since (string)
updated_before (string)
updated_since (string)
sort_field (string)
sort_dir (string)
marketing/post_audiences_by_audience_id_contactsCreate a new omni-channel contact for an audience.audience_id (string) required
data: {
. language (string)
. email_channel (object)
. sms_channel (object)
. merge_fields (object)
. tags (array)
. update_existing (boolean)
} (object) required
merge_field_validation_mode (string)
data_mode (string)
marketing/get_audiences_by_audience_id_contacts_by_contact_idRetrieve a specific omni-channel contact in an audience.audience_id (string) required
contact_id (string) required
fields (string)
exclude_fields (string)
marketing/patch_audiences_by_audience_id_contacts_by_contact_idUpdate an existing omni-channel contact.audience_id (string) required
contact_id (string) required
data: {
. language (string)
. email_channel (object)
. sms_channel (object)
. merge_fields (object)
. tags (array)
} (object) required
merge_field_validation_mode (string)
data_mode (string)
marketing/post_audiences_by_audience_id_contacts_by_contact_id_actions_archiveArchives a Contact.audience_id (string) required
contact_id (string) required
marketing/post_audiences_by_audience_id_contacts_by_contact_id_actions_forgetForgets a Contact.audience_id (string) required
contact_id (string) required
marketing/get_authorized_appsGet a list of an account's registered, connected applications.fields (string)
exclude_fields (string)
count (string)
offset (string)
marketing/get_authorized_apps_by_app_idGet information about a specific authorized application.app_id (string) required
fields (string)
exclude_fields (string)
marketing/get_automationsGet a summary of an account's classic automations.count (string)
offset (string)
fields (string)
exclude_fields (string)
before_create_time (string)
since_create_time (string)
before_start_time (string)
since_start_time (string)
status (string)
marketing/post_automationsCreate a new classic automation in your Mailchimp account.data: {
. recipients (object)
. settings (object)
. trigger_settings (object)
} (object) required
marketing/get_automations_by_workflow_idGet a summary of an individual classic automation workflow's settings and content. The trigger_settings object returns information for the first email in the workflow.workflow_id (string) required
fields (string)
exclude_fields (string)
marketing/post_automations_by_workflow_id_actions_pause_all_emailsPause all emails in a specific classic automation workflow.workflow_id (string) required
marketing/post_automations_by_workflow_id_actions_start_all_emailsStart all emails in a classic automation workflow.workflow_id (string) required
marketing/post_automations_by_workflow_id_actions_archiveArchiving will permanently end your automation and keep the report data. You’ll be able to replicate your archived automation, but you can’t restart it.workflow_id (string) required
marketing/get_automations_by_workflow_id_emailsGet a summary of the emails in a classic automation workflow.workflow_id (string) required
marketing/get_automations_by_workflow_id_emails_by_workflow_email_idGet information about an individual classic automation workflow email.workflow_id (string) required
workflow_email_id (string) required
marketing/delete_automations_by_workflow_id_emails_by_workflow_email_idRemoves an individual classic automation workflow email. Emails from certain workflow types, including the Abandoned Cart Email abandonedCart and Product Retargeting Email abandonedBrowse Workflows, cannot be deleted.workflow_id (string) required
workflow_email_id (string) required
marketing/patch_automations_by_workflow_id_emails_by_workflow_email_idUpdate settings for a classic automation workflow email. Only works with workflows of type: abandonedBrowse, abandonedCart, emailFollowup, or singleWelcome.workflow_id (string) required
workflow_email_id (string) required
data: {
. settings (object)
. delay (object)
} (object) required
marketing/get_automations_by_workflow_id_emails_by_workflow_email_id_queueGet information about a classic automation email queue.workflow_id (string) required
workflow_email_id (string) required
marketing/post_automations_by_workflow_id_emails_by_workflow_email_id_queueManually add a subscriber to a workflow, bypassing the default trigger settings. You can also use this endpoint to trigger a series of automated emails in an API 3.0 workflow type.workflow_id (string) required
workflow_email_id (string) required
data: {
. email_address (string)
} (object) required
marketing/get_automations_by_workflow_id_emails_by_workflow_email_id_queue_by_subscriber_hashGet information about a specific subscriber in a classic automation email queue.workflow_id (string) required
workflow_email_id (string) required
subscriber_hash (string) required
marketing/post_automations_by_workflow_id_emails_by_workflow_email_id_actions_pausePause an automated email.workflow_id (string) required
workflow_email_id (string) required
marketing/post_automations_by_workflow_id_emails_by_workflow_email_id_actions_startStart an automated email.workflow_id (string) required
workflow_email_id (string) required
marketing/get_automations_by_workflow_id_removed_subscribersGet information about subscribers who were removed from a classic automation workflow.workflow_id (string) required
marketing/post_automations_by_workflow_id_removed_subscribersRemove a subscriber from a specific classic automation workflow. You can remove a subscriber at any point in an automation workflow, regardless of how many emails they've been sent from that workflow. Once they're removed, they can never be added back to the same workflow.workflow_id (string) required
data: {
. email_address (string)
} (object) required
marketing/get_automations_by_workflow_id_removed_subscribers_by_subscriber_hashGet information about a specific subscriber who was removed from a classic automation workflow.workflow_id (string) required
subscriber_hash (string) required
marketing/get_batchesGet a summary of batch requests that have been made.fields (string)
exclude_fields (string)
count (string)
offset (string)
marketing/post_batchesBegin processing a batch operations request.data: {
. operations (array)
} (object) required
marketing/get_batches_by_batch_idGet the status of a batch request.batch_id (string) required
fields (string)
exclude_fields (string)
marketing/delete_batches_by_batch_idStops a batch request from running. Since only one batch request is run at a time, this can be used to cancel a long running request. The results of any completed operations will not be available after this call.batch_id (string) required
marketing/get_batch_webhooksGet all webhooks that have been configured for batches.fields (string)
exclude_fields (string)
count (string)
offset (string)
marketing/post_batch_webhooksConfigure a webhook that will fire whenever any batch request completes processing. You may only have a maximum of 20 batch webhooks.data: {
. url (string)
. enabled (boolean)
} (object) required
marketing/get_batch_webhooks_by_batch_webhook_idGet information about a specific batch webhook.batch_webhook_id (string) required
fields (string)
exclude_fields (string)
marketing/patch_batch_webhooks_by_batch_webhook_idUpdate a webhook that will fire whenever any batch request completes processing.batch_webhook_id (string) required
data: {
. url (string)
. enabled (boolean)
} (object) required
marketing/delete_batch_webhooks_by_batch_webhook_idRemove a batch webhook. Webhooks will no longer be sent to the given URL.batch_webhook_id (string) required
marketing/get_template_foldersGet all folders used to organize templates.fields (string)
exclude_fields (string)
count (string)
offset (string)
marketing/post_template_foldersCreate a new template folder.data: {
. name (string)
} (object) required
marketing/get_template_folders_by_folder_idGet information about a specific folder used to organize templates.folder_id (string) required
fields (string)
exclude_fields (string)
marketing/patch_template_folders_by_folder_idUpdate a specific folder used to organize templates.folder_id (string) required
data: {
. name (string)
} (object) required
marketing/delete_template_folders_by_folder_idDelete a specific template folder, and mark all the templates in the folder as 'unfiled'.folder_id (string) required
marketing/get_campaign_foldersGet all folders used to organize campaigns.fields (string)
exclude_fields (string)
count (string)
offset (string)
marketing/post_campaign_foldersCreate a new campaign folder.data: {
. name (string)
} (object) required
marketing/get_campaign_folders_by_folder_idGet information about a specific folder used to organize campaigns.folder_id (string) required
fields (string)
exclude_fields (string)
marketing/patch_campaign_folders_by_folder_idUpdate a specific folder used to organize campaigns.folder_id (string) required
data: {
. name (string)
} (object) required
marketing/delete_campaign_folders_by_folder_idDelete a specific campaign folder, and mark all the campaigns in the folder as 'unfiled'.folder_id (string) required
marketing/get_campaignsGet all campaigns in an account.fields (string)
exclude_fields (string)
count (string)
offset (string)
type (string)
status (string)
before_send_time (string)
since_send_time (string)
before_create_time (string)
since_create_time (string)
list_id (string)
folder_id (string)
member_id (string)
sort_field (string)
sort_dir (string)
include_resend_shortcut_eligibility (string)
include_resend_shortcut_usage (string)
marketing/post_campaignsCreate a new Mailchimp campaign.data: {
. type (string)
. recipients (object)
. settings (object)
. variate_settings (object)
. tracking (object)
. rss_opts (object)
. social_card (object)
. content_type (string)
} (object) required
marketing/get_campaigns_by_campaign_idGet information about a specific campaign.campaign_id (string) required
fields (string)
exclude_fields (string)
include_resend_shortcut_eligibility (string)
include_resend_shortcut_usage (string)
marketing/patch_campaigns_by_campaign_idUpdate some or all of the settings for a specific campaign.campaign_id (string) required
data: {
. recipients (object)
. settings (object)
. variate_settings (object)
. tracking (object)
. rss_opts (object)
. social_card (object)
} (object) required
marketing/delete_campaigns_by_campaign_idRemove a campaign from your Mailchimp account.campaign_id (string) required
marketing/post_campaigns_by_campaign_id_actions_cancel_sendCancel a Regular or Plain-Text Campaign after you send, before all of your recipients receive it. This feature is included with Mailchimp Pro.campaign_id (string) required
marketing/post_campaigns_by_campaign_id_actions_replicateReplicate a campaign in saved or send status.campaign_id (string) required
marketing/post_campaigns_by_campaign_id_actions_sendSend a Mailchimp campaign. For RSS Campaigns, the campaign will send according to its schedule. All other campaigns will send immediately.campaign_id (string) required
marketing/post_campaigns_by_campaign_id_actions_scheduleSchedule a campaign for delivery. If you're using Multivariate Campaigns to test send times or sending RSS Campaigns, use the send action instead.campaign_id (string) required
data: {
. schedule_time (string)
. timewarp (boolean)
. batch_delivery (object)
} (object) required
marketing/post_campaigns_by_campaign_id_actions_unscheduleUnschedule a scheduled campaign that hasn't started sending.campaign_id (string) required
marketing/post_campaigns_by_campaign_id_actions_testSend a test email.campaign_id (string) required
data: {
. test_emails (array)
. send_type (string)
} (object) required
marketing/post_campaigns_by_campaign_id_actions_pausePause an RSS-Driven campaign.campaign_id (string) required
marketing/post_campaigns_by_campaign_id_actions_resumeResume an RSS-Driven campaign.campaign_id (string) required
marketing/post_campaigns_by_campaign_id_actions_create_resendRemove the guesswork for resending a campaign to certain segments. You can use this endpoint as a shortcut to replicate a campaign and resend it to common segments, such as those who didn't open the campaign, or any new subscribers since it was sent.campaign_id (string) required
data: {
. shortcut_type (string)
} (object)
marketing/get_campaigns_by_campaign_id_contentGet the the HTML and plain-text content for a campaign.campaign_id (string) required
fields (string)
exclude_fields (string)
marketing/put_campaigns_by_campaign_id_contentSet the content for a campaign.campaign_id (string) required
data: {
. plain_text (string)
. html (string)
. url (string)
. template (object)
. archive (object)
. variate_contents (array)
} (object) required
marketing/get_campaigns_by_campaign_id_feedbackGet team feedback while you're working together on a Mailchimp campaign.campaign_id (string) required
fields (string)
exclude_fields (string)
marketing/post_campaigns_by_campaign_id_feedbackAdd feedback on a specific campaign.campaign_id (string) required
data: {
. block_id (integer)
. message (string)
. is_complete (boolean)
} (object) required
marketing/get_campaigns_by_campaign_id_feedback_by_feedback_idGet a specific feedback message from a campaign.campaign_id (string) required
feedback_id (string) required
fields (string)
exclude_fields (string)
marketing/patch_campaigns_by_campaign_id_feedback_by_feedback_idUpdate a specific feedback message for a campaign.campaign_id (string) required
feedback_id (string) required
data: {
. block_id (integer)
. message (string)
. is_complete (boolean)
} (object) required
marketing/delete_campaigns_by_campaign_id_feedback_by_feedback_idRemove a specific feedback message for a campaign.campaign_id (string) required
feedback_id (string) required
marketing/get_campaigns_by_campaign_id_send_checklistReview the send checklist for a campaign, and resolve any issues before sending.campaign_id (string) required
fields (string)
exclude_fields (string)
marketing/get_connected_sitesGet all connected sites in an account.fields (string)
exclude_fields (string)
count (string)
offset (string)
marketing/post_connected_sitesCreate a new Mailchimp connected site.data: {
. foreign_id (string)
. domain (string)
} (object) required
marketing/get_connected_sites_by_connected_site_idGet information about a specific connected site.connected_site_id (string) required
fields (string)
exclude_fields (string)
marketing/delete_connected_sites_by_connected_site_idRemove a connected site from your Mailchimp account.connected_site_id (string) required
marketing/post_connected_sites_by_connected_site_id_actions_verify_script_installationVerify that the connected sites script has been installed, either via the script URL or fragment.connected_site_id (string) required
marketing/post_connected_sites_by_connected_site_id_actions_enable_pixelEnable the Mailchimp tracking pixel for a connected site.connected_site_id (string) required
marketing/post_connected_sites_by_connected_site_id_actions_disable_pixelDisable the Mailchimp tracking pixel for a connected site.connected_site_id (string) required
marketing/get_conversationsGet a list of conversations for the account. Conversations has been deprecated in favor of Inbox and these endpoints don't include Inbox data. Past Conversations are still available via this endpoint, but new campaign replies and other Inbox messages aren’t available using this endpoint.fields (string)
exclude_fields (string)
count (string)
offset (string)
has_unread_messages (string)
list_id (string)
campaign_id (string)
marketing/get_conversations_by_conversation_idGet details about an individual conversation. Conversations has been deprecated in favor of Inbox and these endpoints don't include Inbox data. Past Conversations are still available via this endpoint, but new campaign replies and other Inbox messages aren’t available using this endpoint.conversation_id (string) required
fields (string)
exclude_fields (string)
marketing/get_conversations_by_conversation_id_messagesGet messages from a specific conversation. Conversations has been deprecated in favor of Inbox and these endpoints don't include Inbox data. Past Conversations are still available via this endpoint, but new campaign replies and other Inbox messages aren’t available using this endpoint.conversation_id (string) required
fields (string)
exclude_fields (string)
is_read (string)
before_timestamp (string)
since_timestamp (string)
marketing/get_conversations_by_conversation_id_messages_by_message_idGet an individual message in a conversation. Conversations has been deprecated in favor of Inbox and these endpoints don't include Inbox data. Past Conversations are still available via this endpoint, but new campaign replies and other Inbox messages aren’t available using this endpoint.conversation_id (string) required
message_id (string) required
fields (string)
exclude_fields (string)
marketing/post_customer_journeys_journeys_by_journey_id_steps_by_step_id_actions_triggerA step trigger in an Automation flow. To use it, create a starting point or step from the Automation flow builder in the app using the Customer Journey API condition. We’ll provide a url during the process that includes the journey_id and step_id. You’ll then be able to use this endpoint to trigger the condition for the posted contact.journey_id (string) required
step_id (string) required
data: {
. email_address (string)
} (object) required
marketing/get_file_manager_filesGet a list of available images and files stored in the File Manager for the account.fields (string)
exclude_fields (string)
count (string)
offset (string)
type (string)
created_by (string)
before_created_at (string)
since_created_at (string)
sort_field (string)
sort_dir (string)
marketing/post_file_manager_filesUpload a new image or file to the File Manager.data: {
. folder_id (integer)
. name (string)
. file_data (string)
} (object) required
marketing/get_file_manager_files_by_file_idGet information about a specific file in the File Manager.file_id (string) required
fields (string)
exclude_fields (string)
marketing/patch_file_manager_files_by_file_idUpdate a file in the File Manager.file_id (string) required
data: {
. folder_id (integer)
. name (string)
} (object) required
marketing/delete_file_manager_files_by_file_idRemove a specific file from the File Manager.file_id (string) required
marketing/get_file_manager_foldersGet a list of all folders in the File Manager.fields (string)
exclude_fields (string)
count (string)
offset (string)
created_by (string)
before_created_at (string)
since_created_at (string)
marketing/post_file_manager_foldersCreate a new folder in the File Manager.data: {
. name (string)
} (object) required
marketing/get_file_manager_folders_by_folder_idGet information about a specific folder in the File Manager.folder_id (string) required
fields (string)
exclude_fields (string)
marketing/patch_file_manager_folders_by_folder_idUpdate a specific File Manager folder.folder_id (string) required
data: {
. name (string)
} (object) required
marketing/delete_file_manager_folders_by_folder_idDelete a specific folder in the File Manager.folder_id (string) required
marketing/get_file_manager_folders_by_folder_id_filesGet a list of available images and files stored in this folder.folder_id (string) required
fields (string)
exclude_fields (string)
count (string)
offset (string)
type (string)
created_by (string)
before_created_at (string)
since_created_at (string)
sort_field (string)
sort_dir (string)
marketing/get_listsGet information about all lists in the account.fields (string)
exclude_fields (string)
count (string)
offset (string)
before_date_created (string)
since_date_created (string)
before_campaign_last_sent (string)
since_campaign_last_sent (string)
email (string)
sort_field (string)
sort_dir (string)
has_ecommerce_store (string)
include_total_contacts (string)
marketing/post_listsCreate a new list in your Mailchimp account.data: {
. name (string)
. contact (object)
. permission_reminder (string)
. use_archive_bar (boolean)
. campaign_defaults (object)
. notify_on_subscribe (string)
. notify_on_unsubscribe (string)
. email_type_option (boolean)
. double_optin (boolean)
. marketing_permissions (boolean)
} (object) required
marketing/get_lists_by_list_idGet information about a specific list in your Mailchimp account. Results include list members who have signed up but haven't confirmed their subscription yet and unsubscribed or cleaned.list_id (string) required
fields (string)
exclude_fields (string)
include_total_contacts (string)
marketing/patch_lists_by_list_idUpdate the settings for a specific list.list_id (string) required
data: {
. name (string)
. contact (object)
. permission_reminder (string)
. use_archive_bar (boolean)
. campaign_defaults (object)
. notify_on_subscribe (string)
. notify_on_unsubscribe (string)
. email_type_option (boolean)
. double_optin (boolean)
. marketing_permissions (boolean)
} (object) required
marketing/delete_lists_by_list_idDelete a list from your Mailchimp account. If you delete a list, you'll lose the list history—including subscriber activity, unsubscribes, complaints, and bounces. You’ll also lose subscribers’ email addresses, unless you exported and backed up your list.list_id (string) required
marketing/post_lists_by_list_idBatch subscribe or unsubscribe list members.list_id (string) required
skip_merge_validation (string)
skip_duplicate_check (string)
data: {
. members (array)
. sync_tags (boolean)
. update_existing (boolean)
} (object) required
marketing/get_lists_by_list_id_abuse_reportsGet all abuse reports for a specific list.list_id (string) required
fields (string)
exclude_fields (string)
count (string)
offset (string)
marketing/get_lists_by_list_id_abuse_reports_by_report_idGet details about a specific abuse report.list_id (string) required
report_id (string) required
fields (string)
exclude_fields (string)
count (string)
offset (string)
marketing/get_lists_by_list_id_activityGet up to the previous 180 days of daily detailed aggregated activity stats for a list, not including Automation activity.list_id (string) required
count (string)
offset (string)
fields (string)
exclude_fields (string)
marketing/get_lists_by_list_id_clientsGet a list of the top email clients based on user-agent strings.list_id (string) required
fields (string)
exclude_fields (string)
marketing/get_lists_by_list_id_growth_historyGet a month-by-month summary of a specific list's growth activity.list_id (string) required
fields (string)
exclude_fields (string)
count (string)
offset (string)
sort_field (string)
sort_dir (string)
marketing/get_lists_by_list_id_growth_history_by_monthGet a summary of a specific list's growth activity for a specific month and year.list_id (string) required
month (string) required
fields (string)
exclude_fields (string)
marketing/get_lists_by_list_id_interest_categoriesGet information about a list's interest categories.list_id (string) required
fields (string)
exclude_fields (string)
count (string)
offset (string)
type (string)
sort_field (string)
sort_dir (string)
marketing/post_lists_by_list_id_interest_categoriesCreate a new interest category.list_id (string) required
data: {
. title (string)
. display_order (integer)
. type (string)
} (object) required
marketing/get_lists_by_list_id_interest_categories_by_interest_category_idGet information about a specific interest category.list_id (string) required
interest_category_id (string) required
fields (string)
exclude_fields (string)
marketing/patch_lists_by_list_id_interest_categories_by_interest_category_idUpdate a specific interest category.list_id (string) required
interest_category_id (string) required
data: {
. title (string)
. display_order (integer)
. type (string)
} (object) required
marketing/delete_lists_by_list_id_interest_categories_by_interest_category_idDelete a specific interest category.list_id (string) required
interest_category_id (string) required
marketing/get_lists_by_list_id_interest_categories_by_interest_category_id_interestsGet a list of this category's interests.list_id (string) required
interest_category_id (string) required
fields (string)
exclude_fields (string)
count (string)
offset (string)
marketing/post_lists_by_list_id_interest_categories_by_interest_category_id_interestsCreate a new interest or 'group name' for a specific category.list_id (string) required
interest_category_id (string) required
data: {
. name (string)
. display_order (integer)
} (object) required
marketing/get_lists_by_list_id_interest_categories_by_interest_category_id_interests_by_interest_idGet interests or 'group names' for a specific category.list_id (string) required
interest_category_id (string) required
interest_id (string) required
fields (string)
exclude_fields (string)
marketing/patch_lists_by_list_id_interest_categories_by_interest_category_id_interests_by_interest_idUpdate interests or 'group names' for a specific category.list_id (string) required
interest_category_id (string) required
interest_id (string) required
data: {
. name (string)
. display_order (integer)
} (object) required
marketing/delete_lists_by_list_id_interest_categories_by_interest_category_id_interests_by_interest_idDelete interests or group names in a specific category.list_id (string) required
interest_category_id (string) required
interest_id (string) required
marketing/get_lists_by_list_id_segmentsGet information about all available segments for a specific list.list_id (string) required
fields (string)
exclude_fields (string)
count (string)
offset (string)
type (string)
since_created_at (string)
before_created_at (string)
include_cleaned (string)
include_transactional (string)
include_unsubscribed (string)
since_updated_at (string)
before_updated_at (string)
exclude_type (string)
marketing/post_lists_by_list_id_segmentsCreate a new segment in a specific list.list_id (string) required
data: {
. name (string)
. static_segment (array)
. options (object)
} (object) required
marketing/get_lists_by_list_id_segments_by_segment_idGet information about a specific segment.list_id (string) required
segment_id (string) required
fields (string)
exclude_fields (string)
include_cleaned (string)
include_transactional (string)
include_unsubscribed (string)
marketing/delete_lists_by_list_id_segments_by_segment_idDelete a specific segment in a list.list_id (string) required
segment_id (string) required
marketing/patch_lists_by_list_id_segments_by_segment_idUpdate a specific segment in a list.list_id (string) required
segment_id (string) required
data: {
. name (string)
. static_segment (array)
. options (object)
} (object) required
marketing/post_lists_by_list_id_segments_by_segment_idBatch add/remove list members to static segmentlist_id (string) required
segment_id (string) required
data: {
. members_to_add (array)
. members_to_remove (array)
} (object) required
marketing/get_lists_by_list_id_segments_by_segment_id_membersGet information about members in a saved segment.list_id (string) required
segment_id (string) required
fields (string)
exclude_fields (string)
count (string)
offset (string)
include_cleaned (string)
include_transactional (string)
include_unsubscribed (string)
marketing/post_lists_by_list_id_segments_by_segment_id_membersAdd a member to a static segment.list_id (string) required
segment_id (string) required
data: {
. email_address (string)
} (object) required
marketing/delete_lists_by_list_id_segments_by_segment_id_members_by_subscriber_hashRemove a member from the specified static segment.list_id (string) required
segment_id (string) required
subscriber_hash (string) required
marketing/get_lists_by_list_id_tag_searchSearch for tags on a list by name. If no name is provided, will return all tags on the list.list_id (string) required
name (string)
marketing/get_lists_by_list_id_membersGet information about members in a specific Mailchimp list.list_id (string) required
fields (string)
exclude_fields (string)
count (string)
offset (string)
email_type (string)
status (string)
since_timestamp_opt (string)
before_timestamp_opt (string)
since_last_changed (string)
before_last_changed (string)
unique_email_id (string)
vip_only (string)
interest_category_id (string)
interest_ids (string)
interest_match (string)
sort_field (string)
sort_dir (string)
since_last_campaign (string)
unsubscribed_since (string)
marketing/post_lists_by_list_id_membersAdd a new member to the list.list_id (string) required
skip_merge_validation (string)
data: {
. email_address (string)
. email_type (string)
. status (string)
. merge_fields (object)
. interests (object)
. language (string)
. vip (boolean)
. location (object)
. marketing_permissions (array)
. ip_signup (string)
. timestamp_signup (string)
. ip_opt (string)
. timestamp_opt (string)
. tags (array)
} (object) required
marketing/get_lists_by_list_id_members_by_subscriber_hashGet information about a specific list member, including a currently subscribed, unsubscribed, or bounced member.list_id (string) required
subscriber_hash (string) required
fields (string)
exclude_fields (string)
marketing/put_lists_by_list_id_members_by_subscriber_hashAdd or update a list member.list_id (string) required
subscriber_hash (string) required
skip_merge_validation (string)
data: {
. email_address (string)
. status_if_new (string)
. email_type (string)
. status (string)
. merge_fields (object)
. interests (object)
. language (string)
. vip (boolean)
. location (object)
. marketing_permissions (array)
. ip_signup (string)
. timestamp_signup (string)
. ip_opt (string)
. timestamp_opt (string)
} (object) required
marketing/patch_lists_by_list_id_members_by_subscriber_hashUpdate information for a specific list member.list_id (string) required
subscriber_hash (string) required
skip_merge_validation (string)
data: {
. email_address (string)
. email_type (string)
. status (string)
. merge_fields (object)
. interests (object)
. language (string)
. vip (boolean)
. location (object)
. marketing_permissions (array)
. ip_signup (string)
. timestamp_signup (string)
. ip_opt (string)
. timestamp_opt (string)
} (object) required
marketing/delete_lists_by_list_id_members_by_subscriber_hashArchive a list member. To permanently delete, use the delete-permanent action.list_id (string) required
subscriber_hash (string) required
marketing/get_lists_by_list_id_members_by_subscriber_hash_activityGet the last 50 events of a member's activity on a specific list, including opens, clicks, and unsubscribes.list_id (string) required
subscriber_hash (string) required
fields (string)
exclude_fields (string)
action (string)
marketing/get_lists_by_list_id_members_by_subscriber_hash_activity_feedGet a member's activity on a specific list, including opens, clicks, and unsubscribes.list_id (string) required
subscriber_hash (string) required
fields (string)
exclude_fields (string)
count (string)
offset (string)
activity_filters (string)
marketing/get_lists_by_list_id_members_by_subscriber_hash_tagsGet the tags on a list member.list_id (string) required
subscriber_hash (string) required
fields (string)
exclude_fields (string)
count (string)
offset (string)
marketing/post_lists_by_list_id_members_by_subscriber_hash_tagsAdd or remove tags from a list member. If a tag that does not exist is passed in and set as 'active', a new tag will be created.list_id (string) required
subscriber_hash (string) required
data: {
. tags (array)
. is_syncing (boolean)
} (object) required
marketing/get_lists_by_list_id_members_by_subscriber_hash_eventsGet events for a contact.list_id (string) required
subscriber_hash (string) required
count (string)
offset (string)
fields (string)
exclude_fields (string)
marketing/post_lists_by_list_id_members_by_subscriber_hash_eventsAdd an event for a list member.list_id (string) required
subscriber_hash (string) required
data: {
. name (string)
. properties (object)
. is_syncing (boolean)
. occurred_at (string)
} (object) required
marketing/get_lists_by_list_id_members_by_subscriber_hash_goalsGet the last 50 Goal events for a member on a specific list.list_id (string) required
subscriber_hash (string) required
fields (string)
exclude_fields (string)
marketing/get_lists_by_list_id_members_by_subscriber_hash_notesGet recent notes for a specific list member.list_id (string) required
subscriber_hash (string) required
sort_field (string)
sort_dir (string)
fields (string)
exclude_fields (string)
count (string)
offset (string)
marketing/post_lists_by_list_id_members_by_subscriber_hash_notesAdd a new note for a specific subscriber.list_id (string) required
subscriber_hash (string) required
data: {
. note (string)
} (object) required
marketing/get_lists_by_list_id_members_by_subscriber_hash_notes_by_note_idGet a specific note for a specific list member.list_id (string) required
subscriber_hash (string) required
note_id (string) required
fields (string)
exclude_fields (string)
marketing/patch_lists_by_list_id_members_by_subscriber_hash_notes_by_note_idUpdate a specific note for a specific list member.list_id (string) required
subscriber_hash (string) required
note_id (string) required
data: {
. note (string)
} (object) required
marketing/delete_lists_by_list_id_members_by_subscriber_hash_notes_by_note_idDelete a specific note for a specific list member.list_id (string) required
subscriber_hash (string) required
note_id (string) required
marketing/post_lists_by_list_id_members_by_subscriber_hash_actions_delete_permanentDelete all personally identifiable information related to a list member, and remove them from a list. This will make it impossible to re-import the list member.list_id (string) required
subscriber_hash (string) required
marketing/get_lists_by_list_id_merge_fieldsGet a list of all merge fields for an audience.list_id (string) required
fields (string)
exclude_fields (string)
count (string)
offset (string)
type (string)
required (string)
marketing/post_lists_by_list_id_merge_fieldsAdd a new merge field for a specific audience.list_id (string) required
data: {
. tag (string)
. name (string)
. type (string)
. required (boolean)
. default_value (string)
. public (boolean)
. display_order (integer)
. options (object)
. help_text (string)
} (object) required
marketing/get_lists_by_list_id_merge_fields_by_merge_idGet information about a specific merge field.list_id (string) required
merge_id (string) required
exclude_fields (string)
fields (string)
marketing/patch_lists_by_list_id_merge_fields_by_merge_idUpdate a specific merge field.list_id (string) required
merge_id (string) required
data: {
. tag (string)
. name (string)
. required (boolean)
. default_value (string)
. public (boolean)
. display_order (integer)
. options (object)
. help_text (string)
} (object) required
marketing/delete_lists_by_list_id_merge_fields_by_merge_idDelete a specific merge field.list_id (string) required
merge_id (string) required
marketing/get_lists_by_list_id_webhooksGet information about all webhooks for a specific list.list_id (string) required
marketing/post_lists_by_list_id_webhooksCreate a new webhook for a specific list.list_id (string) required
data: {
. url (string)
. events (object)
. sources (object)
} (object) required
marketing/get_lists_by_list_id_webhooks_by_webhook_idGet information about a specific webhook.list_id (string) required
webhook_id (string) required
marketing/delete_lists_by_list_id_webhooks_by_webhook_idDelete a specific webhook in a list.list_id (string) required
webhook_id (string) required
marketing/patch_lists_by_list_id_webhooks_by_webhook_idUpdate the settings for an existing webhook.list_id (string) required
webhook_id (string) required
data: {
. url (string)
. events (object)
. sources (object)
} (object) required
marketing/get_lists_by_list_id_signup_formsGet signup forms for a specific list.list_id (string) required
marketing/post_lists_by_list_id_signup_formsCustomize a list's default signup form.list_id (string) required
data: {
. header (object)
. contents (array)
. styles (array)
} (object) required
marketing/get_lists_by_list_id_locationsGet the locations countries that the list's subscribers have been tagged to based on geocoding their IP address.list_id (string) required
fields (string)
exclude_fields (string)
marketing/get_lists_by_list_id_surveysGet information about all available surveys for a specific list.list_id (string) required
marketing/post_lists_by_list_id_surveysCreate a draft survey for an audience.list_id (string) required
data: {
. title (string)
. sections (array)
} (object) required
marketing/get_lists_by_list_id_surveys_by_survey_idGet details about a specific survey.list_id (string) required
survey_id (string) required
marketing/patch_lists_by_list_id_surveys_by_survey_idUpdate a survey. When sections is provided, send the complete section list in display order. Any existing section not included is deleted.list_id (string) required
survey_id (string) required
data: {
. title (string)
. is_piped_to_inbox (boolean)
. sections (array)
} (object) required
marketing/delete_lists_by_list_id_surveys_by_survey_idDelete a survey.list_id (string) required
survey_id (string) required
marketing/post_lists_by_list_id_surveys_by_survey_id_actions_publishPublish a survey that is in draft, unpublished, or has been previously published and edited.list_id (string) required
survey_id (string) required
marketing/post_lists_by_list_id_surveys_by_survey_id_actions_unpublishUnpublish a survey that has been published.list_id (string) required
survey_id (string) required
marketing/post_lists_by_list_id_surveys_by_survey_id_actions_create_emailUtilize the List ID and Survey ID to generate a Campaign that links to your survey.list_id (string) required
survey_id (string) required
marketing/post_lists_by_list_id_surveys_by_survey_id_actions_replicateReplicate a survey.list_id (string) required
survey_id (string) required
data: {
. title (string)
. list_id (string)
} (object)
marketing/get_landing_pagesGet all landing pages.sort_dir (string)
sort_field (string)
fields (string)
exclude_fields (string)
count (string)
marketing/post_landing_pagesCreate an unpublished and contentless Mailchimp landing page.data: {
. name (string)
. title (string)
. description (string)
. store_id (string)
. list_id (string)
. type (string)
. template_id (integer)
. tracking (object)
} (object) required
use_default_list (string)
marketing/get_landing_pages_by_page_idGet information about a specific page.page_id (string) required
fields (string)
exclude_fields (string)
marketing/patch_landing_pages_by_page_idUpdate a landing page.page_id (string) required
data: {
. name (string)
. title (string)
. description (string)
. store_id (string)
. list_id (string)
. tracking (object)
} (object) required
marketing/delete_landing_pages_by_page_idDelete a landing page.page_id (string) required
marketing/post_landing_pages_by_page_id_actions_publishPublish a landing page that is in draft, unpublished, or has been previously published and edited.page_id (string) required
marketing/post_landing_pages_by_page_id_actions_unpublishUnpublish a landing page that is in draft or has been published.page_id (string) required
marketing/get_landing_pages_by_page_id_contentGet the the HTML for your landing page.page_id (string) required
fields (string)
exclude_fields (string)
marketing/get_reportsGet campaign reports.fields (string)
exclude_fields (string)
count (string)
offset (string)
type (string)
before_send_time (string)
since_send_time (string)
marketing/get_reports_by_campaign_idGet report details for a specific sent campaign.campaign_id (string) required
fields (string)
exclude_fields (string)
marketing/get_reports_by_campaign_id_abuse_reportsGet a list of abuse complaints for a specific campaign.campaign_id (string) required
fields (string)
exclude_fields (string)
marketing/get_reports_by_campaign_id_abuse_reports_by_report_idGet information about a specific abuse report for a campaign.campaign_id (string) required
report_id (string) required
fields (string)
exclude_fields (string)
marketing/get_reports_by_campaign_id_adviceGet feedback based on a campaign's statistics. Advice feedback is based on campaign stats like opens, clicks, unsubscribes, bounces, and more.campaign_id (string) required
fields (string)
exclude_fields (string)
marketing/get_reports_by_campaign_id_click_detailsGet information about clicks on specific links in your Mailchimp campaigns.campaign_id (string) required
fields (string)
exclude_fields (string)
count (string)
offset (string)
sort_field (string)
sort_dir (string)
marketing/get_reports_by_campaign_id_click_details_by_link_idGet click details for a specific link in a campaign.campaign_id (string) required
link_id (string) required
fields (string)
exclude_fields (string)
marketing/get_reports_by_campaign_id_click_details_by_link_id_membersGet information about list members who clicked on a specific link in a campaign.campaign_id (string) required
link_id (string) required
fields (string)
exclude_fields (string)
count (string)
offset (string)
marketing/get_reports_by_campaign_id_click_details_by_link_id_members_by_subscriber_hashGet information about a specific subscriber who clicked a link in a specific campaign.campaign_id (string) required
link_id (string) required
subscriber_hash (string) required
fields (string)
exclude_fields (string)
marketing/get_reports_by_campaign_id_open_detailsGet detailed information about any campaign emails that were opened by a list member.campaign_id (string) required
fields (string)
exclude_fields (string)
count (string)
offset (string)
since (string)
sort_field (string)
sort_dir (string)
marketing/get_reports_by_campaign_id_open_details_by_subscriber_hashGet information about a specific subscriber who opened a campaign.campaign_id (string) required
subscriber_hash (string) required
fields (string)
exclude_fields (string)
marketing/get_reports_by_campaign_id_domain_performanceGet statistics for the top-performing email domains in a campaign.campaign_id (string) required
fields (string)
exclude_fields (string)
marketing/get_reports_by_campaign_id_eepurlGet a summary of social activity for the campaign, tracked by EepURL.campaign_id (string) required
fields (string)
exclude_fields (string)
marketing/get_reports_by_campaign_id_email_activityGet a list of member's subscriber activity in a specific campaign.campaign_id (string) required
fields (string)
exclude_fields (string)
count (string)
offset (string)
since (string)
marketing/get_reports_by_campaign_id_email_activity_by_subscriber_hashGet a specific list member's activity in a campaign including opens, clicks, and bounces.campaign_id (string) required
subscriber_hash (string) required
fields (string)
exclude_fields (string)
since (string)
marketing/get_reports_by_campaign_id_locationsGet top open locations for a specific campaign.campaign_id (string) required
fields (string)
exclude_fields (string)
count (string)
offset (string)
marketing/get_reports_by_campaign_id_sent_toGet information about campaign recipients.campaign_id (string) required
fields (string)
exclude_fields (string)
count (string)
offset (string)
marketing/get_reports_by_campaign_id_sent_to_by_subscriber_hashGet information about a specific campaign recipient.campaign_id (string) required
subscriber_hash (string) required
fields (string)
exclude_fields (string)
marketing/get_reports_by_campaign_id_sub_reportsGet a list of reports with child campaigns for a specific parent campaign.campaign_id (string) required
fields (string)
exclude_fields (string)
marketing/get_reports_by_campaign_id_unsubscribedGet information about members who have unsubscribed from a specific campaign.campaign_id (string) required
fields (string)
exclude_fields (string)
count (string)
offset (string)
marketing/get_reports_by_campaign_id_unsubscribed_by_subscriber_hashGet information about a specific list member who unsubscribed from a campaign.campaign_id (string) required
subscriber_hash (string) required
fields (string)
exclude_fields (string)
marketing/get_reports_by_campaign_id_ecommerce_product_activityGet breakdown of product activity for a campaigncampaign_id (string) required
fields (string)
exclude_fields (string)
count (string)
offset (string)
sort_field (string)
marketing/get_templatesGet a list of an account's available templates.fields (string)
exclude_fields (string)
count (string)
offset (string)
created_by (string)
since_date_created (string)
before_date_created (string)
type (string)
category (string)
folder_id (string)
sort_field (string)
content_type (string)
sort_dir (string)
marketing/post_templatesCreate a new template for the account. Only Classic templates are supported.data: {
. name (string)
. folder_id (string)
. html (string)
} (object) required
marketing/get_templates_by_template_idGet information about a specific template.template_id (string) required
fields (string)
exclude_fields (string)
marketing/patch_templates_by_template_idUpdate the name, HTML, or folder_id of an existing template.template_id (string) required
data: {
. name (string)
. folder_id (string)
. html (string)
} (object) required
marketing/delete_templates_by_template_idDelete a specific template.template_id (string) required
marketing/get_templates_by_template_id_default_contentGet the sections that you can edit in a template, including each section's default content.template_id (string) required
fields (string)
exclude_fields (string)
marketing/get_ecommerce_ordersGet information about an account's orders.fields (string)
exclude_fields (string)
count (string)
offset (string)
campaign_id (string)
outreach_id (string)
customer_id (string)
has_outreach (string)
marketing/get_ecommerce_storesGet information about all stores in the account.fields (string)
exclude_fields (string)
count (string)
offset (string)
marketing/post_ecommerce_storesAdd a new store to your Mailchimp account.data: {
. id (string)
. list_id (string)
. name (string)
. platform (string)
. domain (string)
. is_syncing (boolean)
. email_address (string)
. currency_code (string)
. money_format (string)
. primary_locale (string)
. timezone (string)
. phone (string)
. address (object)
} (object) required
marketing/get_ecommerce_stores_by_store_idGet information about a specific store.store_id (string) required
fields (string)
exclude_fields (string)
marketing/patch_ecommerce_stores_by_store_idUpdate a store.store_id (string) required
data: {
. name (string)
. platform (string)
. domain (string)
. is_syncing (boolean)
. email_address (string)
. currency_code (string)
. money_format (string)
. primary_locale (string)
. timezone (string)
. phone (string)
. address (object)
} (object) required
marketing/delete_ecommerce_stores_by_store_idDelete a store. Deleting a store will also delete any associated subresources, including Customers, Orders, Products, and Carts.store_id (string) required
marketing/get_ecommerce_stores_by_store_id_cartsGet information about a store's carts.store_id (string) required
fields (string)
exclude_fields (string)
count (string)
offset (string)
marketing/post_ecommerce_stores_by_store_id_cartsAdd a new cart to a store.store_id (string) required
data: {
. id (string)
. customer (object)
. campaign_id (string)
. checkout_url (string)
. currency_code (string)
. order_total (number)
. tax_total (number)
. lines (array)
} (object) required
marketing/get_ecommerce_stores_by_store_id_carts_by_cart_idGet information about a specific cart.store_id (string) required
cart_id (string) required
fields (string)
exclude_fields (string)
marketing/patch_ecommerce_stores_by_store_id_carts_by_cart_idUpdate a specific cart.store_id (string) required
cart_id (string) required
data: {
. customer (object)
. campaign_id (string)
. checkout_url (string)
. currency_code (string)
. order_total (number)
. tax_total (number)
. lines (array)
} (object) required
marketing/delete_ecommerce_stores_by_store_id_carts_by_cart_idDelete a cart.store_id (string) required
cart_id (string) required
marketing/get_ecommerce_stores_by_store_id_carts_by_cart_id_linesGet information about a cart's line items.store_id (string) required
cart_id (string) required
fields (string)
exclude_fields (string)
count (string)
offset (string)
marketing/post_ecommerce_stores_by_store_id_carts_by_cart_id_linesAdd a new line item to an existing cart.store_id (string) required
cart_id (string) required
data: {
. id (string)
. product_id (string)
. product_variant_id (string)
. quantity (integer)
. price (number)
} (object) required
marketing/get_ecommerce_stores_by_store_id_carts_by_cart_id_lines_by_line_idGet information about a specific cart line item.store_id (string) required
cart_id (string) required
line_id (string) required
fields (string)
exclude_fields (string)
marketing/patch_ecommerce_stores_by_store_id_carts_by_cart_id_lines_by_line_idUpdate a specific cart line item.store_id (string) required
cart_id (string) required
line_id (string) required
data: {
. product_id (string)
. product_variant_id (string)
. quantity (integer)
. price (number)
} (object) required
marketing/delete_ecommerce_stores_by_store_id_carts_by_cart_id_lines_by_line_idDelete a specific cart line item.store_id (string) required
cart_id (string) required
line_id (string) required
marketing/get_ecommerce_stores_by_store_id_customersGet information about a store's customers.store_id (string) required
fields (string)
exclude_fields (string)
count (string)
offset (string)
email_address (string)
marketing/post_ecommerce_stores_by_store_id_customersAdd a new customer to a store.store_id (string) required
data: {
. id (string)
. email_address (string)
. sms_phone_number (string)
. opt_in_status (boolean)
. company (string)
. first_name (string)
. last_name (string)
. address (object)
} (object) required
marketing/get_ecommerce_stores_by_store_id_customers_by_customer_idGet information about a specific customer.store_id (string) required
customer_id (string) required
fields (string)
exclude_fields (string)
marketing/put_ecommerce_stores_by_store_id_customers_by_customer_idAdd or update a customer.store_id (string) required
customer_id (string) required
data: {
. id (string)
. email_address (string)
. sms_phone_number (string)
. opt_in_status (boolean)
. company (string)
. first_name (string)
. last_name (string)
. address (object)
} (object) required
marketing/patch_ecommerce_stores_by_store_id_customers_by_customer_idUpdate a customer.store_id (string) required
customer_id (string) required
data: {
. opt_in_status (boolean)
. company (string)
. first_name (string)
. last_name (string)
. address (object)
} (object) required
marketing/delete_ecommerce_stores_by_store_id_customers_by_customer_idDelete a customer from a store.store_id (string) required
customer_id (string) required
marketing/get_ecommerce_stores_by_store_id_promo_rulesGet information about a store's promo rules.store_id (string) required
fields (string)
exclude_fields (string)
count (string)
offset (string)
marketing/post_ecommerce_stores_by_store_id_promo_rulesAdd a new promo rule to a store.store_id (string) required
data: {
. id (string)
. title (string)
. description (string)
. starts_at (string)
. ends_at (string)
. amount (number)
. type (string)
. target (string)
. enabled (boolean)
. created_at_foreign (string)
. updated_at_foreign (string)
} (object) required
marketing/get_ecommerce_stores_by_store_id_promo_rules_by_promo_rule_idGet information about a specific promo rule.store_id (string) required
promo_rule_id (string) required
fields (string)
exclude_fields (string)
marketing/patch_ecommerce_stores_by_store_id_promo_rules_by_promo_rule_idUpdate a promo rule.store_id (string) required
promo_rule_id (string) required
data: {
. title (string)
. description (string)
. starts_at (string)
. ends_at (string)
. amount (number)
. type (string)
. target (string)
. enabled (boolean)
. created_at_foreign (string)
. updated_at_foreign (string)
} (object) required
marketing/delete_ecommerce_stores_by_store_id_promo_rules_by_promo_rule_idDelete a promo rule from a store.store_id (string) required
promo_rule_id (string) required
marketing/get_ecommerce_stores_by_store_id_promo_rules_by_promo_rule_id_promo_codesGet information about a store's promo codes.promo_rule_id (string) required
store_id (string) required
fields (string)
exclude_fields (string)
count (string)
offset (string)
marketing/post_ecommerce_stores_by_store_id_promo_rules_by_promo_rule_id_promo_codesAdd a new promo code to a store.store_id (string) required
promo_rule_id (string) required
data: {
. id (string)
. code (string)
. redemption_url (string)
. usage_count (integer)
. enabled (boolean)
. created_at_foreign (string)
. updated_at_foreign (string)
} (object) required
marketing/get_ecommerce_stores_by_store_id_promo_rules_by_promo_rule_id_promo_codes_by_promo_code_idGet information about a specific promo code.store_id (string) required
promo_rule_id (string) required
promo_code_id (string) required
fields (string)
exclude_fields (string)
marketing/patch_ecommerce_stores_by_store_id_promo_rules_by_promo_rule_id_promo_codes_by_promo_code_idUpdate a promo code.store_id (string) required
promo_rule_id (string) required
promo_code_id (string) required
data: {
. code (string)
. redemption_url (string)
. usage_count (integer)
. enabled (boolean)
. created_at_foreign (string)
. updated_at_foreign (string)
} (object) required
marketing/delete_ecommerce_stores_by_store_id_promo_rules_by_promo_rule_id_promo_codes_by_promo_code_idDelete a promo code from a store.store_id (string) required
promo_rule_id (string) required
promo_code_id (string) required
marketing/get_ecommerce_stores_by_store_id_ordersGet information about a store's orders.store_id (string) required
fields (string)
exclude_fields (string)
count (string)
offset (string)
customer_id (string)
has_outreach (string)
campaign_id (string)
outreach_id (string)
marketing/post_ecommerce_stores_by_store_id_ordersAdd a new order to a store.store_id (string) required
data: {
. id (string)
. customer (object)
. campaign_id (string)
. cart_id (string)
. landing_site (string)
. financial_status (string)
. fulfillment_status (string)
. currency_code (string)
. order_total (number)
. order_url (string)
. discount_total (number)
. tax_total (number)
. shipping_total (number)
. tracking_code (string)
. processed_at_foreign (string)
. cancelled_at_foreign (string)
. updated_at_foreign (string)
. shipping_address (object)
. billing_address (object)
. promos (array)
. lines (array)
. outreach (object)
. tracking_number (string)
. tracking_carrier (string)
. tracking_url (string)
} (object) required
marketing/get_ecommerce_stores_by_store_id_orders_by_order_idGet information about a specific order.store_id (string) required
order_id (string) required
fields (string)
exclude_fields (string)
marketing/put_ecommerce_stores_by_store_id_orders_by_order_idAdd or update an order.store_id (string) required
order_id (string) required
data: {
. id (string)
. customer (object)
. campaign_id (string)
. cart_id (string)
. landing_site (string)
. financial_status (string)
. fulfillment_status (string)
. currency_code (string)
. order_total (number)
. order_url (string)
. discount_total (number)
. tax_total (number)
. shipping_total (number)
. tracking_code (string)
. processed_at_foreign (string)
. cancelled_at_foreign (string)
. updated_at_foreign (string)
. shipping_address (object)
. billing_address (object)
. promos (array)
. lines (array)
. outreach (object)
. tracking_number (string)
. tracking_carrier (string)
. tracking_url (string)
} (object) required
marketing/patch_ecommerce_stores_by_store_id_orders_by_order_idUpdate a specific order.store_id (string) required
order_id (string) required
data: {
. customer (object)
. campaign_id (string)
. cart_id (string)
. landing_site (string)
. financial_status (string)
. fulfillment_status (string)
. currency_code (string)
. order_total (number)
. order_url (string)
. discount_total (number)
. tax_total (number)
. shipping_total (number)
. tracking_code (string)
. processed_at_foreign (string)
. cancelled_at_foreign (string)
. updated_at_foreign (string)
. shipping_address (object)
. billing_address (object)
. promos (array)
. lines (array)
. outreach (object)
. tracking_number (string)
. tracking_carrier (string)
. tracking_url (string)
} (object) required
marketing/delete_ecommerce_stores_by_store_id_orders_by_order_idDelete an order.store_id (string) required
order_id (string) required
marketing/get_ecommerce_stores_by_store_id_orders_by_order_id_linesGet information about an order's line items.store_id (string) required
order_id (string) required
fields (string)
exclude_fields (string)
count (string)
offset (string)
marketing/post_ecommerce_stores_by_store_id_orders_by_order_id_linesAdd a new line item to an existing order.store_id (string) required
order_id (string) required
data: {
. id (string)
. product_id (string)
. product_variant_id (string)
. product (object)
. quantity (integer)
. price (number)
. discount (number)
} (object) required
marketing/get_ecommerce_stores_by_store_id_orders_by_order_id_lines_by_line_idGet information about a specific order line item.store_id (string) required
order_id (string) required
line_id (string) required
fields (string)
exclude_fields (string)
marketing/patch_ecommerce_stores_by_store_id_orders_by_order_id_lines_by_line_idUpdate a specific order line item.store_id (string) required
order_id (string) required
line_id (string) required
data: {
. product_id (string)
. product_variant_id (string)
. quantity (integer)
. price (number)
. discount (number)
} (object) required
marketing/delete_ecommerce_stores_by_store_id_orders_by_order_id_lines_by_line_idDelete a specific order line item.store_id (string) required
order_id (string) required
line_id (string) required
marketing/get_ecommerce_stores_by_store_id_productsGet information about a store's products.store_id (string) required
fields (string)
exclude_fields (string)
count (string)
offset (string)
marketing/post_ecommerce_stores_by_store_id_productsAdd a new product to a store.store_id (string) required
data: {
. id (string)
. title (string)
. handle (string)
. url (string)
. description (string)
. type (string)
. vendor (string)
. image_url (string)
. variants (array)
. images (array)
. published_at_foreign (string)
} (object) required
marketing/get_ecommerce_stores_by_store_id_products_by_product_idGet information about a specific product.store_id (string) required
product_id (string) required
fields (string)
exclude_fields (string)
marketing/patch_ecommerce_stores_by_store_id_products_by_product_idUpdate a specific product.store_id (string) required
product_id (string) required
data: {
. title (string)
. handle (string)
. url (string)
. description (string)
. type (string)
. vendor (string)
. image_url (string)
. variants (array)
. images (array)
. published_at_foreign (string)
} (object) required
marketing/put_ecommerce_stores_by_store_id_products_by_product_idUpdate a specific product.store_id (string) required
product_id (string) required
data: {
. id (string)
. title (string)
. handle (string)
. url (string)
. description (string)
. type (string)
. vendor (string)
. image_url (string)
. variants (array)
. images (array)
. published_at_foreign (string)
} (object) required
marketing/delete_ecommerce_stores_by_store_id_products_by_product_idDelete a product.store_id (string) required
product_id (string) required
marketing/get_ecommerce_stores_by_store_id_products_by_product_id_variantsGet information about a product's variants.store_id (string) required
product_id (string) required
fields (string)
exclude_fields (string)
count (string)
offset (string)
marketing/post_ecommerce_stores_by_store_id_products_by_product_id_variantsAdd a new variant to the product.store_id (string) required
product_id (string) required
data: {
. id (string)
. title (string)
. url (string)
. sku (string)
. price (number)
. inventory_quantity (integer)
. image_url (string)
. backorders (string)
. visibility (string)
} (object) required
marketing/get_ecommerce_stores_by_store_id_products_by_product_id_variants_by_variant_idGet information about a specific product variant.store_id (string) required
product_id (string) required
variant_id (string) required
fields (string)
exclude_fields (string)
marketing/put_ecommerce_stores_by_store_id_products_by_product_id_variants_by_variant_idAdd or update a product variant.store_id (string) required
product_id (string) required
variant_id (string) required
data: {
. id (string)
. title (string)
. url (string)
. sku (string)
. price (number)
. inventory_quantity (integer)
. image_url (string)
. backorders (string)
. visibility (string)
} (object) required
marketing/patch_ecommerce_stores_by_store_id_products_by_product_id_variants_by_variant_idUpdate a product variant.store_id (string) required
product_id (string) required
variant_id (string) required
data: {
. title (string)
. url (string)
. sku (string)
. price (number)
. inventory_quantity (integer)
. image_url (string)
. backorders (string)
. visibility (string)
} (object) required
marketing/delete_ecommerce_stores_by_store_id_products_by_product_id_variants_by_variant_idDelete a product variant.store_id (string) required
product_id (string) required
variant_id (string) required
marketing/get_ecommerce_stores_by_store_id_products_by_product_id_imagesGet information about a product's images.store_id (string) required
product_id (string) required
fields (string)
exclude_fields (string)
count (string)
offset (string)
marketing/post_ecommerce_stores_by_store_id_products_by_product_id_imagesAdd a new image to the product.store_id (string) required
product_id (string) required
data: {
. id (string)
. url (string)
. variant_ids (array)
} (object) required
marketing/get_ecommerce_stores_by_store_id_products_by_product_id_images_by_image_idGet information about a specific product image.store_id (string) required
product_id (string) required
image_id (string) required
fields (string)
exclude_fields (string)
marketing/patch_ecommerce_stores_by_store_id_products_by_product_id_images_by_image_idUpdate a product image.store_id (string) required
product_id (string) required
image_id (string) required
data: {
. id (string)
. url (string)
. variant_ids (array)
} (object) required
marketing/delete_ecommerce_stores_by_store_id_products_by_product_id_images_by_image_idDelete a product image.store_id (string) required
product_id (string) required
image_id (string) required
marketing/get_search_campaignsSearch all campaigns for the specified query terms.fields (string)
exclude_fields (string)
query (string) required
marketing/get_sms_campaignsGet all SMS campaigns in an account.fields (string)
exclude_fields (string)
count (string)
offset (string)
marketing/post_sms_campaignsCreate a new SMS campaign.data: {
. name (string)
. list_id (integer)
. folder_id (string)
. segments (array)
. excluded_segments (array)
} (object) required
marketing/get_sms_campaigns_by_sms_campaign_idGet information about a specific SMS campaign.sms_campaign_id (string) required
fields (string)
exclude_fields (string)
marketing/patch_sms_campaigns_by_sms_campaign_idUpdate some or all of the settings for a specific SMS campaign.sms_campaign_id (string) required
data: {
. name (string)
. folder_id (string)
. segments (array)
. excluded_segments (array)
} (object) required
marketing/delete_sms_campaigns_by_sms_campaign_idRemove an SMS campaign from your Mailchimp account.sms_campaign_id (string) required
marketing/post_sms_campaigns_by_sms_campaign_id_actions_sendSend an SMS campaign.sms_campaign_id (string) required
marketing/post_sms_campaigns_by_sms_campaign_id_actions_scheduleSchedule an SMS campaign to send at a specific time.sms_campaign_id (string) required
data: {
. schedule_time (string)
} (object) required
marketing/post_sms_campaigns_by_sms_campaign_id_actions_cancel_sendCancel a scheduled or sending SMS campaign.sms_campaign_id (string) required
marketing/get_sms_campaigns_by_sms_campaign_id_contentGet the content for an SMS campaign.sms_campaign_id (string) required
fields (string)
exclude_fields (string)
marketing/put_sms_campaigns_by_sms_campaign_id_contentSet the content for an SMS campaign.sms_campaign_id (string) required
data: {
. message_body (string)
. media (array)
} (object) required
marketing/get_search_membersSearch for list members. This search can be restricted to a specific list, or can be used to search across all lists in an account.fields (string)
exclude_fields (string)
query (string) required
list_id (string)
marketing/get_pingA health check for the API that won't return any account-specific information.No parameters
marketing/get_facebook_adsGet list of Facebook ads.fields (string)
exclude_fields (string)
count (string)
offset (string)
sort_field (string)
sort_dir (string)
marketing/get_facebook_ads_by_outreach_idGet details of a Facebook ad.outreach_id (string) required
fields (string)
exclude_fields (string)
marketing/get_reporting_facebook_adsGet reports of Facebook ads.fields (string)
exclude_fields (string)
count (string)
offset (string)
sort_field (string)
sort_dir (string)
marketing/get_reporting_facebook_ads_by_outreach_idGet report of a Facebook ad.outreach_id (string) required
fields (string)
exclude_fields (string)
marketing/get_reporting_facebook_ads_by_outreach_id_ecommerce_product_activityGet breakdown of product activity for an outreach.outreach_id (string) required
fields (string)
exclude_fields (string)
count (string)
offset (string)
sort_field (string)
marketing/get_reporting_landing_pages_by_outreach_idGet report of a landing page.outreach_id (string) required
fields (string)
exclude_fields (string)
marketing/get_reporting_landing_pagesGet reports of landing pages.fields (string)
exclude_fields (string)
count (string)
offset (string)
marketing/get_reporting_surveysGet reports for surveys.fields (string)
exclude_fields (string)
count (string)
offset (string)
marketing/get_reporting_surveys_by_survey_idGet report for a survey.survey_id (string) required
fields (string)
exclude_fields (string)
marketing/get_reporting_surveys_by_survey_id_questionsGet reports for survey questions.survey_id (string) required
fields (string)
exclude_fields (string)
marketing/get_reporting_surveys_by_survey_id_questions_by_question_idGet report for a survey question.survey_id (string) required
question_id (string) required
fields (string)
exclude_fields (string)
marketing/get_reporting_surveys_by_survey_id_questions_by_question_id_answersGet answers for a survey question.survey_id (string) required
question_id (string) required
fields (string)
exclude_fields (string)
respondent_familiarity_is (string)
marketing/get_reporting_surveys_by_survey_id_responsesGet responses to a survey.survey_id (string) required
fields (string)
exclude_fields (string)
answered_question (string)
chose_answer (string)
respondent_familiarity_is (string)
marketing/get_reporting_surveys_by_survey_id_responses_by_response_idGet a single survey response.survey_id (string) required
response_id (string) required
marketing/get_verified_domains_by_domain_nameGet the details for a single domain on the account.domain_name (string) required
marketing/delete_verified_domains_by_domain_nameDelete a verified domain from the account.domain_name (string) required
marketing/post_verified_domains_by_domain_name_actions_verifyVerify a domain for sending.domain_name (string) required
data: {
. code (string)
} (object) required
marketing/get_verified_domainsGet all of the sending domains on the account.No parameters
marketing/post_verified_domainsAdd a domain to the account.data: {
. verification_email (string)
} (object) required
marketing/customCall any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body._url (string) required
_method (string)
_query (object)
_body
_headers (object)
transactional/post_allowlists_addAdds an email to your email rejection allowlist. If the address is currently on your denylist, that denylist entry will be removed automatically.data: {
. email (string)
. comment (string)
} (object) required
transactional/post_allowlists_listRetrieves your email rejection allowlist. You can provide an email address or search prefix to limit the results. Returns up to 1000 results.data: {
. email (string)
} (object) required
transactional/post_allowlists_deleteRemoves an email address from the allowlist.data: {
. email (string)
} (object) required
transactional/post_exports_infoReturns information about an export job. If the export job's state is 'complete', the returned data will include a URL you can use to fetch the results. Every export job produces a zip archive, but the format of the archive is distinct for each job type. The api calls that initiate exports include more details about the output format for that job type.data: {
. id (string)
} (object) required
transactional/post_exports_listReturns a list of your exports.data: {

} (object) required
transactional/post_exports_rejectsBegins an export of your rejection denylist. The denylist will be exported to a zip archive containing a single file named rejects.csv that includes the following fields: email, reason, detail, created_at, expires_at, last_event_at, expires_at.data: {
. notify_email (string)
} (object) required
transactional/post_exports_whitelistBegins an export of your rejection allowlist. The allowlist will be exported to a zip archive containing a single file named allowlist.csv that includes the following fields: email, detail, created_at.data: {
. notify_email (string)
} (object) required
transactional/post_exports_allowlistBegins an export of your rejection allowlist. The allowlist will be exported to a zip archive containing a single file named allowlist.csv that includes the following fields: email, detail, created_at.data: {
. notify_email (string)
} (object) required
transactional/post_exports_activityBegins an export of your activity history. The activity will be exported to a zip archive containing a single file named activity.csv in the same format as you would be able to export from your account's activity view. It includes the following fields: Date, Email Address, Sender, Subject, Status, Tags, Opens, Clicks, Bounce Detail. If you have configured any custom metadata fields, they will be included in the exported data.data: {
. notify_email (string)
. date_from (string)
. date_to (string)
. tags (array)
. senders (array)
. states (array)
. api_keys (array)
} (object) required
transactional/post_inbound_domainsList the domains that have been configured for inbound delivery.data: {

} (object) required
transactional/post_inbound_add_domainAdd an inbound domain to your account.data: {
. domain (string)
} (object) required
transactional/post_inbound_check_domainCheck the MX settings for an inbound domain. The domain must have already been added with the add-domain call.data: {
. domain (string)
} (object) required
transactional/post_inbound_delete_domainDelete an inbound domain from the account. All mail will stop routing for this domain immediately.data: {
. domain (string)
} (object) required
transactional/post_inbound_routesList the routes defined for an inbound domain or SMS program. Provide either domain or phone not both.data: {
. domain (string)
. phone (string)
} (object) required
transactional/post_inbound_add_routeAdd a new route to an inbound domain or SMS program. Provide either domain or phone not both.data: {
. domain (string)
. phone (string)
. pattern (string)
. url (string)
} (object) required
transactional/post_inbound_update_routeUpdate the pattern or webhook of an existing inbound mailbox route. If null is provided for any fields, the values will remain unchanged.data: {
. id (string)
. pattern (string)
. url (string)
} (object) required
transactional/post_inbound_delete_routeDelete an existing inbound mailbox route.data: {
. id (string)
} (object) required
transactional/post_inbound_send_rawTake a raw MIME document destined for a domain with inbound domains set up, and send it to the inbound hook exactly as if it had been sent over SMTP.data: {
. raw_message (string)
. to (array)
. mail_from (string)
. helo (string)
. client_address (string)
} (object) required
transactional/post_ips_listLists your dedicated IPs.data: {

} (object) required
transactional/post_ips_infoRetrieves information about a single dedicated IP.data: {
. ip (string)
} (object) required
transactional/post_ips_provisionRequests an additional dedicated IP for your account. Accounts may have one outstanding request at any time, and provisioning requests are processed within 24 hours.data: {
. warmup (boolean)
. pool (string)
} (object) required
transactional/post_ips_start_warmupBegins the warmup process for a dedicated IP. During the warmup process, the Transactional API will gradually increase the percentage of your mail that is sent over the warming-up IP, over a period of roughly 30 days. The rest of your mail will be sent over shared IPs or other dedicated IPs in the same pool.data: {
. ip (string)
} (object) required
transactional/post_ips_cancel_warmupCancels the warmup process for a dedicated IP.data: {
. ip (string)
} (object) required
transactional/post_ips_set_poolMoves a dedicated IP to a different pool.data: {
. ip (string)
. pool (string)
. create_pool (boolean)
} (object) required
transactional/post_ips_deleteDeletes a dedicated IP. This is permanent and cannot be undone.data: {
. ip (string)
} (object) required
transactional/post_ips_list_poolsLists your dedicated IP pools.data: {

} (object) required
transactional/post_ips_pool_infoDescribes a single dedicated IP pool.data: {
. pool (string)
} (object) required
transactional/post_ips_create_poolCreates a pool and returns it. If a pool already exists with this name, no action will be performed.data: {
. pool (string)
} (object) required
transactional/post_ips_delete_poolDeletes a pool. A pool must be empty before you can delete it, and you cannot delete your default pool.data: {
. pool (string)
} (object) required
transactional/post_ips_check_custom_dnsTests whether a domain name is valid for use as the custom reverse DNS for a dedicated IP.data: {
. ip (string)
. domain (string)
} (object) required
transactional/post_ips_set_custom_dnsConfigures the custom DNS name for a dedicated IP.data: {
. ip (string)
. domain (string)
} (object) required
transactional/post_mctemplates_infoGet information about a Mailchimp Transactional template in your account.data: {
. mc_template_id (integer)
} (object) required
transactional/post_mctemplates_listReturn a list of all Mailchimp Transactional templates available to this user.data: {
. search_query (string,null)
} (object) required
transactional/post_mctemplates_renderRender a Mailchimp Transactional template with optional merge variables.data: {
. mc_template_id (integer)
. mc_template_version (string)
. merge_vars (array)
} (object) required
transactional/post_mctemplates_time_seriesReturn the recent history hourly stats for the last 30 days for a Mailchimp Transactional template. Returns an empty array if the template exists but has never been used to send messages.data: {
. mc_template_id (integer)
} (object) required
transactional/post_messages_send_smsSend a new SMS message through Mandrilldata: {
. message (object)
. async (boolean)
} (object) required
transactional/post_messages_sendSend a new transactional message through the Transactional API.data: {
. message (object)
. async (boolean)
. ip_pool (string)
. send_at (string)
} (object) required
transactional/post_messages_send_templateSend a new transactional message through the Transactional API using a template.data: {
. template_name (string)
. template_content (array)
. message (object)
. async (boolean)
. ip_pool (string)
. send_at (string)
} (object) required
transactional/post_messages_send_mc_templateSend a new transactional message through Mandrill using a Mailchimp Transactional template.data: {
. mc_template_id (integer)
. mc_template_version (string)
. message (object)
. async (boolean)
. ip_pool (string)
. send_at (string)
} (object) required
transactional/post_messages_searchSearch recently sent messages and optionally narrow by date range, tags, senders, and API keys. If no date range is specified, results within the last 7 days are returned. This method may be called up to 20 times per minute. If you need the data more often, you can use /messages/info.json to get the information for a single message, or webhooks to push activity to your own application for querying.data: {
. query (string)
. date_from (string)
. date_to (string)
. tags (array)
. senders (array)
. api_keys (array)
. limit (integer)
} (object) required
transactional/post_messages_search_time_seriesSearch the content of recently sent messages and return the aggregated hourly stats for matching messages.data: {
. query (string)
. date_from (string)
. date_to (string)
. tags (array)
. senders (array)
} (object) required
transactional/post_messages_infoGet the information for a single recently sent message.data: {
. id (string)
} (object) required
transactional/post_messages_contentGet the full content of a recently sent message.data: {
. id (string)
} (object) required
transactional/post_messages_parseParse the full MIME document for an email message, returning the content of the message broken into its constituent pieces.data: {
. raw_message (string)
} (object) required
transactional/post_messages_send_rawTake a raw MIME document for a message, and send it exactly as if it were sent through the Transactional API's SMTP servers.data: {
. raw_message (string)
. from_email (string)
. from_name (string)
. to (array)
. async (boolean)
. ip_pool (string)
. send_at (string)
. return_path_domain (string)
} (object) required
transactional/post_messages_list_scheduledQueries your scheduled emails.data: {
. to (string)
} (object) required
transactional/post_messages_cancel_scheduledCancels a scheduled email.data: {
. id (string)
} (object) required
transactional/post_messages_rescheduleReschedules a scheduled email.data: {
. id (string)
. send_at (string)
} (object) required
transactional/post_metadata_listGet the list of custom metadata fields indexed for the account.data: {

} (object) required
transactional/post_metadata_addAdd a new custom metadata field to be indexed for the account.data: {
. name (string)
. view_template (string)
} (object) required
transactional/post_metadata_updateUpdate an existing custom metadata field.data: {
. name (string)
. view_template (string)
} (object) required
transactional/post_metadata_deleteDelete an existing custom metadata field. Deletion isn't instataneous, and /metadata/list will continue to return the field until the asynchronous deletion process is complete.data: {
. name (string)
} (object) required
transactional/post_rejects_addAdds an email to your email rejection denylist. Addresses that you add manually will never expire and there is no reputation penalty for removing them from your denylist. Attempting to denylist an address that has been added to the allowlist will have no effect.data: {
. email (string)
. comment (string)
. subaccount (string)
} (object) required
transactional/post_rejects_listRetrieves your email rejection denylist. You can provide an email address to limit the results. Returns up to 1000 results. By default, entries that have expired are excluded from the results; set include_expired to true to include them.data: {
. email (string)
. include_expired (boolean)
. subaccount (string)
} (object) required
transactional/post_rejects_deleteDeletes an email rejection. There is no limit to how many rejections you can remove from your denylist, but keep in mind that each deletion has an affect on your reputation.data: {
. email (string)
. subaccount (string)
} (object) required
transactional/post_senders_listReturn the senders that have tried to use this account.data: {

} (object) required
transactional/post_senders_domainsReturns the sender domains that have been added to this account.data: {

} (object) required
transactional/post_senders_add_domainAdds a sender domain to your account. Sender domains are added automatically as you send, but you can use this call to add them ahead of time.data: {
. domain (string)
} (object) required
transactional/post_senders_delete_domainDeletes an unverified sender domain from your account. Verified domains cannot be deleted via API and require login confirmation.data: {
. domain (string)
} (object) required
transactional/post_senders_check_domainChecks the SPF and DKIM settings for a domain, as well the domain verification. If you haven't already added this domain to your account, it will be added automatically.data: {
. domain (string)
} (object) required
transactional/post_senders_verify_domainSends a verification email in order to verify ownership of a domain. Domain verification is a required step to confirm ownership of a domain. Once a domain has been verified in a Transactional API account, other accounts may not have their messages signed by that domain unless they also verify the domain. This prevents other Transactional API accounts from sending mail signed by your domain.data: {
. domain (string)
. mailbox (string)
} (object) required
transactional/post_senders_infoReturn more detailed information about a single sender, including aggregates of recent stats.data: {
. address (string)
} (object) required
transactional/post_senders_time_seriesReturn the recent history hourly stats for the last 30 days for a sender.data: {
. address (string)
} (object) required
transactional/post_subaccounts_listGet the list of subaccounts defined for the account, optionally filtered by a prefix.data: {
. q (string)
} (object) required
transactional/post_subaccounts_addAdd a new subaccount.data: {
. id (string)
. name (string)
. notes (string)
. custom_quota (integer)
} (object) required
transactional/post_subaccounts_infoGiven the ID of an existing subaccount, return the data about it.data: {
. id (string)
} (object) required
transactional/post_subaccounts_updateUpdate an existing subaccount.data: {
. id (string)
. name (string)
. notes (string)
. custom_quota (integer)
} (object) required
transactional/post_subaccounts_deleteDelete an existing subaccount. Any email related to the subaccount will be saved, but stats will be removed and any future sending calls to this subaccount will fail.data: {
. id (string)
} (object) required
transactional/post_subaccounts_pausePause a subaccount's sending. Any future emails delivered to this subaccount will be queued for a maximum of 3 days until the subaccount is resumed.data: {
. id (string)
} (object) required
transactional/post_subaccounts_resumeResume a paused subaccount's sending.data: {
. id (string)
} (object) required
transactional/post_tags_listReturn all of the user-defined tag information.data: {

} (object) required
transactional/post_tags_deleteDeletes a tag permanently. Deleting a tag removes the tag from any messages that have been sent, and also deletes the tag's stats. There is no way to undo this operation, so use it carefully.data: {
. tag (string)
} (object) required
transactional/post_tags_infoReturn more detailed information about a single tag, including aggregates of recent stats.data: {
. tag (string)
} (object) required
transactional/post_tags_time_seriesReturn the recent history hourly stats for the last 30 days for a tag.data: {
. tag (string)
} (object) required
transactional/post_tags_all_time_seriesReturn the recent history hourly stats for the last 30 days for all tags.data: {

} (object) required
transactional/post_templates_addAdd a new template.data: {
. name (string)
. from_email (string)
. from_name (string)
. subject (string)
. code (string)
. text (string)
. publish (boolean)
. labels (array)
} (object) required
transactional/post_templates_infoGet the information for an existing template.data: {
. name (string)
} (object) required
transactional/post_templates_updateUpdate the code for an existing template. If null is provided for any fields, the values will remain unchanged.data: {
. name (string)
. from_email (string)
. from_name (string)
. subject (string)
. code (string)
. text (string)
. publish (boolean)
. labels (array)
} (object) required
transactional/post_templates_publishPublish the content for the template. Any new messages sent using this template will start using the content that was previously in draft.data: {
. name (string)
} (object) required
transactional/post_templates_deleteDelete a template.data: {
. name (string)
} (object) required
transactional/post_templates_listReturn a list of all the templates available to this user.data: {
. label (string)
} (object) required
transactional/post_templates_time_seriesReturn the recent history hourly stats for the last 30 days for a template.data: {
. name (string)
} (object) required
transactional/post_templates_renderInject content and optionally merge fields into a template, returning the HTML that results.data: {
. template_name (string)
. template_content (array)
. merge_vars (array)
} (object) required
transactional/post_urls_tracking_domainsGet the list of tracking domains set up for this account.data: {

} (object) required
transactional/post_urls_add_tracking_domainAdd a tracking domain to your account.data: {
. domain (string)
} (object) required
transactional/post_urls_delete_tracking_domainDeletes an unverified tracking domain from your account. Valid tracking domains cannot be deleted via API and require login confirmation.data: {
. domain (string)
} (object) required
transactional/post_urls_check_tracking_domainChecks the CNAME settings for a tracking domain. The domain must have been added already with the add-tracking-domain call.data: {
. domain (string)
} (object) required
transactional/post_users_infoReturn the information about the API-connected user.data: {

} (object) required
transactional/post_users_pingValidate an API key and respond to a ping.data: {

} (object) required
transactional/post_users_ping2Validate an API key and respond to a ping JSON parser version.data: {

} (object) required
transactional/post_users_sendersReturn the senders that have tried to use this account, both verified and unverified.data: {

} (object) required
transactional/post_webhooks_listGet the list of all webhooks defined on the account.data: {

} (object) required
transactional/post_webhooks_addAdd a new webhook.data: {
. url (string)
. description (string)
. events (array)
} (object) required
transactional/post_webhooks_infoGiven the ID of an existing webhook, return the data about it.data: {
. id (integer)
} (object) required
transactional/post_webhooks_updateUpdate an existing webhook.data: {
. id (number)
. url (string)
. description (string)
. events (array)
} (object) required
transactional/post_webhooks_deleteDelete an existing webhook.data: {
. id (integer)
} (object) required
transactional/post_rejects_add_smsAdds a phone number to your SMS rejection denylist. Phone numbers that you add manually will never expire and there is no reputation penalty for removing them from your denylist.data: {
. phone (string)
. comment (string)
. subaccount (string)
} (object) required
transactional/post_rejects_list_smsRetrieves your SMS rejection denylist. You can provide a phone number to limit the results. Returns up to 1000 results. By default, entries that have expired are excluded from the results; set include_expired to true to include them.data: {
. phone (string)
. include_expired (boolean)
. subaccount (string)
} (object) required
transactional/post_rejects_delete_smsDeletes an SMS rejection. There is no limit to how many rejections you can remove from your denylist, but keep in mind that each deletion has an affect on your reputation.data: {
. phone (string)
. subaccount (string)
} (object) required
transactional/customCall any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body._url (string) required
_method (string)
_query (object)
_body
_headers (object)