cakemail-mcp-server
Version:
Enterprise MCP server for Cakemail API integration with Claude AI - includes comprehensive template management, list management, sub-account management, BEEeditor visual email design, and advanced analytics
1,852 lines • 607 kB
TypeScript
/**
* This file was auto-generated by openapi-typescript.
* Do not make direct changes to the file.
*/
export interface paths {
"/accounts/self": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Show my account details */
get: operations["getSelfAccount"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
/** Update my account */
patch: operations["patchSelfAccount"];
trace?: never;
};
"/accounts/self/convert-to-organization": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Convert my account to an Organization */
post: operations["convertSelfAccountToOrganization"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/workflows/{workflow_id}/actions": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* List actions
* @deprecated
*/
get: operations["listActions"];
put?: never;
/**
* Create an action
* @deprecated
*/
post: operations["createAction"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/workflows/{workflow_id}/actions/{action_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get an action
* @deprecated
*/
get: operations["getAction"];
put?: never;
post?: never;
/**
* Delete an action
* @deprecated
*/
delete: operations["deleteAction"];
options?: never;
head?: never;
/**
* Update an action
* @deprecated
*/
patch: operations["patchAction"];
trace?: never;
};
"/workflows/{workflow_id}/actions/{action_id}/render": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Render an action
* @deprecated
*/
get: operations["renderAction"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/workflows/{workflow_id}/actions/{action_id}/send-test": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Send a test of an action
* @deprecated
*/
post: operations["sendTestAction"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/campaigns": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Show all campaigns */
get: operations["listCampaigns"];
put?: never;
/** Create a campaign */
post: operations["createCampaign"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/campaigns/{campaign_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Show a campaign details */
get: operations["getCampaign"];
put?: never;
post?: never;
/** Delete a campaign */
delete: operations["deleteCampaign"];
options?: never;
head?: never;
/** Update a campaign */
patch: operations["patchCampaign"];
trace?: never;
};
"/campaigns/{campaign_id}/render": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Render a campaign */
get: operations["renderCampaign"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/campaigns/{campaign_id}/send-test": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Send a test email */
post: operations["sendTestEmail"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/campaigns/{campaign_id}/schedule": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Schedule a campaign */
post: operations["scheduleCampaign"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/campaigns/{campaign_id}/unschedule": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Unschedule a campaign */
post: operations["unscheduleCampaign"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/campaigns/{campaign_id}/reschedule": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Reschedule a campaign */
post: operations["rescheduleCampaign"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/campaigns/{campaign_id}/suspend": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Suspend a campaign */
post: operations["suspendCampaign"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/campaigns/{campaign_id}/resume": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Resume a campaign */
post: operations["resumeCampaign"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/campaigns/{campaign_id}/cancel": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Cancel a campaign */
post: operations["cancelCampaign"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/campaigns/{campaign_id}/archive": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Archive a campaign
* @description You can only delete a campaign when the status is draft. However, if you want to remove a campaign from your list of active campaigns, you can archive it.
*/
post: operations["archiveCampaign"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/campaigns/{campaign_id}/unarchive": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Unarchive a campaign */
post: operations["unarchiveCampaign"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/campaigns/{campaign_id}/revisions": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Show all campaign revisions */
get: operations["getCampaignRevisions"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/campaign-blueprints": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Show all campaign blueprints */
get: operations["listCampaignBlueprints"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/campaign-blueprints/{blueprint_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get a campaign blueprint */
get: operations["getCampaignBlueprint"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/campaign-blueprints/{blueprint_id}/render": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Render campaign blueprint */
get: operations["renderCampaignBlueprint"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/lists/{list_id}/contacts/add-interests": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Add interest(s) to contact(s) */
post: operations["addInterestsToContacts"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/lists/{list_id}/contacts": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Show contacts of a list */
get: operations["listContactsOfList"];
put?: never;
/** Add a contact */
post: operations["createContact"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/lists/{list_id}/segments/{segment_id}/contacts": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Show contacts of a segment */
get: operations["listContactsOfSegment"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/lists/{list_id}/contacts/tag": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Tags multiple contacts */
post: operations["tagMultipleContacts"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/lists/{list_id}/contacts/untag": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Untags multiple contacts */
post: operations["untagMultipleContacts"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/lists/{list_id}/contacts/{contact_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Show a contact details */
get: operations["getContact"];
put?: never;
post?: never;
/** Delete a contact */
delete: operations["deleteContact"];
options?: never;
head?: never;
/** Update a contact */
patch: operations["patchContact"];
trace?: never;
};
"/lists/{list_id}/import-contacts": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Import contacts
* @description Synchronize your own list with Cakemail by importing to your active, unsubscribed or delete contacts.
*/
post: operations["importContacts"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/lists/{list_id}/contacts/{contact_id}/unsubscribe": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Unsubscribe a contact from a list */
post: operations["unsubscribeContact"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/lists/{list_id}/contacts/{contact_id}/tag": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Tags a contact
* @deprecated
*/
post: operations["tagContact"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/lists/{list_id}/contacts/{contact_id}/untag": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Untags a contact
* @deprecated
*/
post: operations["untagContact"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/lists/{list_id}/contacts/remove-interests": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Remove interest(s) from contact(s) */
post: operations["removeInterestsFromContacts"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/lists/{list_id}/custom-attributes": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Show all custom attributes */
get: operations["listCustomAttributes"];
put?: never;
/** Create a custom attribute */
post: operations["createCustomAttribute"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/lists/{list_id}/custom-attributes/{name}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Show a custom attribute */
get: operations["getCustomAttribute"];
put?: never;
post?: never;
/** Delete a custom attribute */
delete: operations["deleteCustomAttribute"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/brands/default/dkim": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** List Dkim Keys */
get: operations["list_dkim_keys_brands_default_dkim_get"];
put?: never;
/** Create Dkim Key */
post: operations["create_dkim_key_brands_default_dkim_post"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/brands/default/dkim/{id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get Dkim Key */
get: operations["get_dkim_key_brands_default_dkim__id__get"];
put?: never;
post?: never;
/** Delete Dkim Key */
delete: operations["delete_dkim_key_brands_default_dkim__id__delete"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/brands/default/domains/default": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Show domains
* @description Show the Tracking and Bounce domains.
*/
get: operations["showDomains"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
/**
* Change domains
* @description Change the Tracking and Bounce domains.
*/
patch: operations["patchDomains"];
trace?: never;
};
"/brands/default/domains/default/validate": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Validate domains
* @description Validate and return the DNS entries for the Tracking and the Bounce domains.
*/
get: operations["validateDomains"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/emails": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Send an email
* @deprecated
*/
post: operations["sendEmail"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/reports/emails": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Show email stats */
get: operations["getEmailsStats"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/logs/emails": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Show email activity logs
* @deprecated
*/
get: operations["getEmailLogs"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/email-group-ids": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* List Email Group Ids
* @deprecated
*/
get: operations["listEmailGroupIds"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/email-group-ids/{group_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
/**
* Edit an Email Group Id
* @deprecated
*/
patch: operations["patchEmailGroupId"];
trace?: never;
};
"/v2/emails": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Submit an email
* @description Submit an email to be sent.
*
* Email status lifecycle:
* - `submitted`: Email has been submitted to the API using this endpoint.
* - `queued`: Email has been queued for delivery.
* - `delivered`: Email has been successfully delivered.
* - `rejected`: Email has been rejected by the API. See the `reason` in `metadata` for more information.
* - `error`: Email has encountered an error. See the `error` in `metadata` for more information.
* - `open`: Email has been opened.
* - `click`: Email has been clicked.
* - `bounce`: Email has bounced.
* - `spam`: Email has been marked as spam.
* - `unsubscribe`: Email has been unsubscribed.
* - `global_unsubscribe`: Email has been globally unsubscribed (suppressed by user request).
*/
post: operations["submitEmail"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v2/emails/{email_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Retrieve a submitted email */
get: operations["showEmail"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v2/emails/{email_id}/render": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Render a submitted email */
get: operations["renderEmail"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/email-tags": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* List Email Tags
* @description Email Tags are used to group sent emails into a logical group or category. This endpoint will return a list of
* all the Email Tags that have been created for the account.
*
* To create a tag, specify its name at send time in the `tags` field of the email object. If the tag does not exist,
* it will be created automatically.
*/
get: operations["listEmailTags"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v2/logs/emails": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Show Email API activity logs */
get: operations["getEmailAPILogs"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/logs/emails-summary": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Show Email API activity summary */
get: operations["getEmailAPISummary"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v2/reports/emails": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Show Email API statistics
* @description Generate email statistics for the Email API.
*
* Statistics are aggregated with a minimum granularity of 5 minutes. As a result, the
* returned intervals may extend beyond the requested time range. Intervals are always
* whole, except for the last interval if the requested end time is the current time.
*/
get: operations["getEmailAPIStats"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/lists/{list_id}/transactional-email-templates": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* List Transactional Email Templates
* @deprecated
* @description List Transactional Email Templates
*/
get: operations["listTransactionalEmailTemplates"];
put?: never;
/**
* Create a Transactional Email Template
* @deprecated
* @description Create a Transactional Email Template
*/
post: operations["createTransactionalEmailTemplate"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/lists/{list_id}/transactional-email-templates/{transactional_email_template_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Show a Transactional Email Template
* @deprecated
* @description Show a Transactional Email Template
*/
get: operations["showTransactionalEmailTemplate"];
put?: never;
post?: never;
/**
* Delete a Transactional Email Template
* @deprecated
* @description Delete a Transactional Email Template
*/
delete: operations["deleteTransactionalEmailTemplate"];
options?: never;
head?: never;
/**
* Update a Transactional Email Template
* @deprecated
* @description Update a Transactional Email Template
*/
patch: operations["updateTransactionalEmailTemplate"];
trace?: never;
};
"/lists/{list_id}/transactional-email-templates/{transactional_email_template_id}/send": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Send a Transactional Email from a Template to a contact
* @deprecated
* @description Send a Transactional Email from a Template to a single contact in the list.
*
* If you need to send to multiple contacts at once, you should use the Campaigns API, which are designed for
* bulk sending.
*/
post: operations["sendTransactionalEmail"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/lists/{list_id}/transactional-email-templates/{transactional_email_template_id}/send-test": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Send a Test Transactional Email from a Template
* @deprecated
* @description Send a Test Transactional Email from a Template
*/
post: operations["sendTestTransactionalEmail"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/lists/{list_id}/transactional-email-templates/{transactional_email_template_id}/render": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Render a Transactional Email Template
* @deprecated
* @description Render a Transactional Email Template
*/
post: operations["renderTransactionalEmailTemplate"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/forms": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Show all forms */
get: operations["listForms"];
put?: never;
/** Create a form */
post: operations["createForm"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/forms/{form_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Show a form details */
get: operations["getForm"];
put?: never;
post?: never;
/** Delete a form */
delete: operations["deleteForm"];
options?: never;
head?: never;
/** Update a form */
patch: operations["patchForm"];
trace?: never;
};
"/links/{link_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Show a link information */
get: operations["getLink"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/campaigns/{campaign_id}/links": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Show a campaign links */
get: operations["listLinks"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/workflows/{workflow_id}/actions/{action_id}/links": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Show action links
* @deprecated
*/
get: operations["listActionLinks"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/lists": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Show all lists */
get: operations["listLists"];
put?: never;
/** Create a List */
post: operations["createList"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/lists/{list_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Show a list parameters */
get: operations["getList"];
put?: never;
post?: never;
/** Delete a List */
delete: operations["deleteList"];
options?: never;
head?: never;
/** Update a list parameters */
patch: operations["patchList"];
trace?: never;
};
"/lists/{list_id}/accept-policy": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Accept policy for a list */
post: operations["acceptListPolicy"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/lists/{list_id}/archive": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Archive a list */
post: operations["archiveList"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/lists/{list_id}/forms/{form_id}/enable": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Enable a subscription form endpoint */
post: operations["enableSubscriptionFormEndpoint"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/lists/{list_id}/forms/{form_id}/disable": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Disable a subscription form endpoint */
post: operations["disableSubscriptionFormEndpoint"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/lists/{list_id}/forms": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** List subscription form endpoints */
get: operations["listSubscriptionFormEndpoints"];
put?: never;
/** Create a subscription form endpoint */
post: operations["createSubscriptionFormEndpoint"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/lists/{list_id}/forms/{form_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Show a subscription form endpoint */
get: operations["showSubscriptionFormEndpoint"];
put?: never;
post?: never;
/** Delete a subscription form endpoint */
delete: operations["deleteSubscriptionFormEndpoint"];
options?: never;
head?: never;
/** Patch a subscription form endpoint */
patch: operations["patchSubscriptionFormEndpoint"];
trace?: never;
};
"/lists/{list_id}/exports": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Show all Contacts Exports
* @description Show all Contacts Exports.
*/
get: operations["listContactsExports"];
put?: never;
/**
* Create a Contacts Export
* @description Create a Contacts Export to a CSV file.
*/
post: operations["exportContacts"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/lists/{list_id}/exports/{export_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Show a Contacts Export
* @description Show a Contacts Export.
*/
get: operations["getContactsExport"];
put?: never;
post?: never;
/**
* Delete a Contacts Export
* @description Delete a Contacts Export.
*/
delete: operations["deleteContactsExport"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/lists/{list_id}/exports/{export_id}/download": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Download a Contacts Export
* @description Download a Contacts Export.
*/
get: operations["downloadContactsExport"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/logs/lists/{list_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Show list logs */
get: operations["getListLogs"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/logs/campaigns/{campaign_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Show campaign logs */
get: operations["getCampaignLogs"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/logs/workflows/{workflow_id}/actions/{action_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Show action logs */
get: operations["getActionLogs"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/logs/campaigns/{campaign_id}/exports": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Show all campaign log exports
* @description Show all campaign log exports
*/
get: operations["listCampaignLogExports"];
put?: never;
/**
* Create a campaign log export
* @description Export to CSV a campaign log.
*/
post: operations["campaignLogExportCreate"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/logs/campaigns/{campaign_id}/exports/{campaign_log_export_id}/download": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Download a campaign log export
* @description Returns the URL to download the exported CSV file.
*/
get: operations["campaignLogExportDownload"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/logs/lists/{list_id}/exports": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Show all list logs exports
* @description Show all list logs exports
*/
get: operations["listListLogsExports"];
put?: never;
/**
* Create a list log export
* @description Export List Activity Logs to CSV.
*/
post: operations["listLogsExportCreate"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/logs/lists/{list_id}/exports/{list_logs_export_id}/download": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Download a list logs export
* @description Returns the URL to download the exported CSV file.
*/
get: operations["listLogsExportDownload"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/brands/default/logos/default": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
/** Upload a default logo */
put: operations["uploadDefaultLogo"];
post?: never;
/** Delete the default logo */
delete: operations["deleteDefaultLogo"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/lists/{list_id}/segments": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Show all segments */
get: operations["listSegments"];
put?: never;
/** Create a segment */
post: operations["createSegment"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/lists/{list_id}/segments/{segment_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Show a segment details */
get: operations["getSegment"];
put?: never;
post?: never;
/** Delete a segment */
delete: operations["deleteSegment"];
options?: never;
head?: never;
/** Update a segment */
patch: operations["patchSegment"];
trace?: never;
};
"/brands/default/senders": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Show all senders */
get: operations["listSenders"];
put?: never;
/** Add a sender */
post: operations["createSender"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/brands/default/senders/{sender_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Show a sender details */
get: operations["getSender"];
put?: never;
post?: never;
/** Delete a sender */
delete: operations["deleteSender"];
options?: never;
head?: never;
/** Update a sender */
patch: operations["patchSender"];
trace?: never;
};
"/brands/default/senders/confirm-email": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Confirm a sender */
post: operations["confirmSender"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/brands/default/senders/{sender_id}/resend-confirmation-email": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Resend confirmation email */
post: operations["resendConfirmationEmail"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/lists/{list_id}/interests": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Show all Interests */
get: operations["listInterests"];
put?: never;
/** Create an Interest */
post: operations["createInterest"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/lists/{list_id}/interests/{interest_name}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get an Interest */
get: operations["getInterest"];
put?: never;
post?: never;
/** Delete an Interest */
delete: operations["deleteInterest"];
options?: never;
head?: never;
/** Update an Interest */
patch: operations["patchInterest"];
trace?: never;
};
"/tasks": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Show all asynchronous Tasks
* @description Show all asynchronous Task.
*/
get: operations["listTasks"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/tasks/{task_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Show an asynchronous Task
* @description Show an asynchronous Task.
*/
get: operations["getTask"];
put?: never;
post?: never;
/**
* Delete an asynchronous Task
* @description Delete an asynchronous Task.
*/
delete: operations["deleteTask"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/templates": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Show all templates */
get: operations["listTemplates"];
put?: never;
/** Create a template */
post: operations["createTemplate"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/templates/{template_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get a template */
get: operations["getTemplate"];
put?: never;
post?: never;
/** Delete a template */
delete: operations["deleteTemplate"];
options?: never;
head?: never;
/** Update a template */
patch: operations["patchTemplate"];
trace?: never;
};
"/templates/{template_id}/render": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Render a template */
get: operations["renderTemplate"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/reports/lists/{list_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Show list report */
get: operations["getListStats"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/reports/campaigns/{campaign_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Show campaign report */
get: operations["getCampaignStats"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/reports/campaigns/{campaign_id}/links": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Show campaign links report */
get: operations["getCampaignLinksStats"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/reports/accounts/self": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: