Skip to main content
Server path: /mailchimp-content | Type: Application | PCID required: Yes

Tools

ToolDescription
mailchimp_content_delete_file_manager_files_idDelete file
mailchimp_content_delete_file_manager_folders_idDelete folder
mailchimp_content_delete_landing_page_idDelete landing page
mailchimp_content_delete_template_folders_idDelete template folder
mailchimp_content_delete_templates_idDelete template
mailchimp_content_get_all_landing_pagesList landing pages
mailchimp_content_get_file_manager_filesList stored files
mailchimp_content_get_file_manager_files_idGet file
mailchimp_content_get_file_manager_foldersList folders
mailchimp_content_get_file_manager_folders_filesList stored files
mailchimp_content_get_file_manager_folders_idGet folder
mailchimp_content_get_landing_page_idGet landing page info
mailchimp_content_get_landing_page_id_contentGet landing page content
mailchimp_content_get_template_foldersList template folders
mailchimp_content_get_template_folders_idGet template folder
mailchimp_content_get_templatesList templates
mailchimp_content_get_templates_idGet template info
mailchimp_content_get_templates_id_default_contentView default content
mailchimp_content_patch_file_manager_files_idUpdate file
mailchimp_content_patch_file_manager_folders_idUpdate folder
mailchimp_content_patch_landing_page_idUpdate landing page
mailchimp_content_patch_template_folders_idUpdate template folder
mailchimp_content_patch_templates_idUpdate template
mailchimp_content_post_all_landing_pagesAdd landing page
mailchimp_content_post_file_manager_filesAdd file
mailchimp_content_post_file_manager_foldersAdd folder
mailchimp_content_post_landing_page_id_actions_publishPublish landing page
mailchimp_content_post_landing_page_id_actions_unpublishUnpublish landing page
mailchimp_content_post_template_foldersAdd template folder
mailchimp_content_post_templatesAdd template

mailchimp_content_delete_file_manager_files_id

Delete file Parameters:
ParameterTypeRequiredDefaultDescription
file_idstringYesThe unique id for the File Manager file.

mailchimp_content_delete_file_manager_folders_id

Delete folder Parameters:
ParameterTypeRequiredDefaultDescription
folder_idstringYesThe unique id for the File Manager folder.

mailchimp_content_delete_landing_page_id

Delete landing page Parameters:
ParameterTypeRequiredDefaultDescription
page_idstringYesThe unique id for the page.

mailchimp_content_delete_template_folders_id

Delete template folder Parameters:
ParameterTypeRequiredDefaultDescription
folder_idstringYesThe unique id for the template folder.

mailchimp_content_delete_templates_id

Delete template Parameters:
ParameterTypeRequiredDefaultDescription
template_idstringYesThe unique id for the template.

mailchimp_content_get_all_landing_pages

List landing pages Parameters:
ParameterTypeRequiredDefaultDescription
sort_dirstringNoDetermines the order direction for sorted results.
sort_fieldstringNoReturns files sorted by the specified field.
fieldsstring[]NoA comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
exclude_fieldsstring[]NoA comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
countintegerNoThe number of records to return. Default value is 10. Maximum value is 1000

mailchimp_content_get_file_manager_files

List stored files Parameters:
ParameterTypeRequiredDefaultDescription
fieldsstring[]NoA comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
exclude_fieldsstring[]NoA comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
countintegerNoThe number of records to return. Default value is 10. Maximum value is 1000
offsetintegerNoUsed for pagination, this is the number of records from a collection to skip. Default value is 0.
typestringNoThe file type for the File Manager file.
created_bystringNoThe Mailchimp account user who created the File Manager file.
before_created_atstringNoRestrict the response to files created before the set date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.
since_created_atstringNoRestrict the response to files created after the set date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.
sort_fieldstringNoReturns files sorted by the specified field.
sort_dirstringNoDetermines the order direction for sorted results.

mailchimp_content_get_file_manager_files_id

Get file Parameters:
ParameterTypeRequiredDefaultDescription
fieldsstring[]NoA comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
exclude_fieldsstring[]NoA comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
file_idstringYesThe unique id for the File Manager file.

mailchimp_content_get_file_manager_folders

List folders Parameters:
ParameterTypeRequiredDefaultDescription
fieldsstring[]NoA comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
exclude_fieldsstring[]NoA comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
countintegerNoThe number of records to return. Default value is 10. Maximum value is 1000
offsetintegerNoUsed for pagination, this is the number of records from a collection to skip. Default value is 0.
created_bystringNoThe Mailchimp account user who created the File Manager file.
before_created_atstringNoRestrict the response to files created before the set date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.
since_created_atstringNoRestrict the response to files created after the set date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.

mailchimp_content_get_file_manager_folders_files

List stored files Parameters:
ParameterTypeRequiredDefaultDescription
folder_idstringYesThe unique id for the File Manager folder.
fieldsstring[]NoA comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
exclude_fieldsstring[]NoA comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
countintegerNoThe number of records to return. Default value is 10. Maximum value is 1000
offsetintegerNoUsed for pagination, this is the number of records from a collection to skip. Default value is 0.
typestringNoThe file type for the File Manager file.
created_bystringNoThe Mailchimp account user who created the File Manager file.
before_created_atstringNoRestrict the response to files created before the set date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.
since_created_atstringNoRestrict the response to files created after the set date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.
sort_fieldstringNoReturns files sorted by the specified field.
sort_dirstringNoDetermines the order direction for sorted results.

mailchimp_content_get_file_manager_folders_id

Get folder Parameters:
ParameterTypeRequiredDefaultDescription
fieldsstring[]NoA comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
exclude_fieldsstring[]NoA comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
folder_idstringYesThe unique id for the File Manager folder.

mailchimp_content_get_landing_page_id

Get landing page info Parameters:
ParameterTypeRequiredDefaultDescription
fieldsstring[]NoA comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
exclude_fieldsstring[]NoA comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
page_idstringYesThe unique id for the page.

mailchimp_content_get_landing_page_id_content

Get landing page content Parameters:
ParameterTypeRequiredDefaultDescription
fieldsstring[]NoA comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
exclude_fieldsstring[]NoA comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
page_idstringYesThe unique id for the page.

mailchimp_content_get_template_folders

List template folders Parameters:
ParameterTypeRequiredDefaultDescription
fieldsstring[]NoA comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
exclude_fieldsstring[]NoA comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
countintegerNoThe number of records to return. Default value is 10. Maximum value is 1000
offsetintegerNoUsed for pagination, this is the number of records from a collection to skip. Default value is 0.

mailchimp_content_get_template_folders_id

Get template folder Parameters:
ParameterTypeRequiredDefaultDescription
fieldsstring[]NoA comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
exclude_fieldsstring[]NoA comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
folder_idstringYesThe unique id for the template folder.

mailchimp_content_get_templates

List templates Parameters:
ParameterTypeRequiredDefaultDescription
fieldsstring[]NoA comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
exclude_fieldsstring[]NoA comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
countintegerNoThe number of records to return. Default value is 10. Maximum value is 1000
offsetintegerNoUsed for pagination, this is the number of records from a collection to skip. Default value is 0.
created_bystringNoThe Mailchimp account user who created the template.
since_date_createdstringNoRestrict the response to templates created after the set date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.
before_date_createdstringNoRestrict the response to templates created before the set date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.
typestringNoLimit results based on template type.
categorystringNoLimit results based on category.
folder_idstringNoThe unique folder id.
sort_fieldstringNoReturns user templates sorted by the specified field.
content_typestringNoLimit results based on how the template’s content is put together. Only templates of type user can be filtered by content_type. If you want to retrieve saved templates created with the legacy email editor, then filter content_type to template. If you’d rather pull your saved templates for the new editor, filter to multichannel. For code your own templates, filter to html.
sort_dirstringNoDetermines the order direction for sorted results.

mailchimp_content_get_templates_id

Get template info Parameters:
ParameterTypeRequiredDefaultDescription
fieldsstring[]NoA comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
exclude_fieldsstring[]NoA comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
template_idstringYesThe unique id for the template.

mailchimp_content_get_templates_id_default_content

View default content Parameters:
ParameterTypeRequiredDefaultDescription
fieldsstring[]NoA comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
exclude_fieldsstring[]NoA comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
template_idstringYesThe unique id for the template.

mailchimp_content_patch_file_manager_files_id

Update file Parameters:
ParameterTypeRequiredDefaultDescription
file_idstringYesThe unique id for the File Manager file.
folder_idintegerNoThe id of the folder. Setting folder_id to 0 will remove a file from its current folder.
namestringNoThe name of the file.

mailchimp_content_patch_file_manager_folders_id

Update folder Parameters:
ParameterTypeRequiredDefaultDescription
folder_idstringYesThe unique id for the File Manager folder.
namestringNoThe name of the folder.

mailchimp_content_patch_landing_page_id

Update landing page Parameters:
ParameterTypeRequiredDefaultDescription
page_idstringYesThe unique id for the page.
descriptionstringNoThe description of this landing page.
list_idstringNoThe list’s ID associated with this landing page.
namestringNoThe name of this landing page.
store_idstringNoThe ID of the store associated with this landing page.
titlestringNoThe title of this landing page seen in the browser’s title bar.
trackingobjectNoThe tracking settings applied to this landing page.

mailchimp_content_patch_template_folders_id

Update template folder Parameters:
ParameterTypeRequiredDefaultDescription
folder_idstringYesThe unique id for the template folder.
namestringNoThe name of the folder.

mailchimp_content_patch_templates_id

Update template Parameters:
ParameterTypeRequiredDefaultDescription
template_idstringYesThe unique id for the template.
folder_idstringNoThe id of the folder the template is currently in.
htmlstringNoThe raw HTML for the template. We support the Mailchimp Template Language in any HTML code passed via the API.
namestringNoThe name of the template.

mailchimp_content_post_all_landing_pages

Add landing page Parameters:
ParameterTypeRequiredDefaultDescription
use_default_listbooleanNoWill create the Landing Page using the account’s Default List instead of requiring a list_id.
descriptionstringNoThe description of this landing page.
list_idstringNoThe list’s ID associated with this landing page.
namestringNoThe name of this landing page.
store_idstringNoThe ID of the store associated with this landing page.
template_idintegerNoThe template_id of this landing page.
titlestringNoThe title of this landing page seen in the browser’s title bar.
trackingobjectNoThe tracking settings applied to this landing page.
typestringNoThe type of template the landing page has.

mailchimp_content_post_file_manager_files

Add file Parameters:
ParameterTypeRequiredDefaultDescription
file_datastringYesThe base64-encoded contents of the file.
folder_idintegerNoThe id of the folder.
namestringYesThe name of the file.

mailchimp_content_post_file_manager_folders

Add folder Parameters:
ParameterTypeRequiredDefaultDescription
namestringYesThe name of the folder.

mailchimp_content_post_landing_page_id_actions_publish

Publish landing page Parameters:
ParameterTypeRequiredDefaultDescription
page_idstringYesThe unique id for the page.

mailchimp_content_post_landing_page_id_actions_unpublish

Unpublish landing page Parameters:
ParameterTypeRequiredDefaultDescription
page_idstringYesThe unique id for the page.

mailchimp_content_post_template_folders

Add template folder Parameters:
ParameterTypeRequiredDefaultDescription
namestringYesThe name of the folder.

mailchimp_content_post_templates

Add template Parameters:
ParameterTypeRequiredDefaultDescription
folder_idstringNoThe id of the folder the template is currently in.
htmlstringYesThe raw HTML for the template. We support the Mailchimp Template Language in any HTML code passed via the API.
namestringYesThe name of the template.