Class MarketingEmailsApi

Constructors

constructor

new MarketingEmailsApi(configuration, requestFactory?, responseProcessor?): MarketingEmailsApi
Parameters
- configuration: Configuration<ObservableMiddleware>
- OptionalrequestFactory: MarketingEmailsApiRequestFactory
- OptionalresponseProcessor: MarketingEmailsApiResponseProcessor
Returns MarketingEmailsApi
- Defined in codegen/marketing/emails/types/PromiseAPI.ts:21

Methods

archiveWithHttpInfo

archiveWithHttpInfo(emailId, archived?, _options?): Promise<HttpInfo<void>>
Delete a marketing email.
Parameters
- emailId: string
  The ID of the marketing email to delete.
- Optionalarchived: boolean
  Whether to return only results that have been archived.
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<void>>
- Defined in codegen/marketing/emails/types/PromiseAPI.ts:34

clone

clone(contentCloneRequestVNext, _options?): Promise<PublicEmail>
This will create a duplicate email with the same properties as the original, with the exception of a unique ID. Clone a marketing email.
Parameters
- contentCloneRequestVNext: ContentCloneRequestVNext
- Optional_options: PromiseConfigurationOptions
Returns Promise<PublicEmail>
- Defined in codegen/marketing/emails/types/PromiseAPI.ts:100

cloneWithHttpInfo

cloneWithHttpInfo(contentCloneRequestVNext, _options?): Promise<HttpInfo<PublicEmail>>
This will create a duplicate email with the same properties as the original, with the exception of a unique ID. Clone a marketing email.
Parameters
- contentCloneRequestVNext: ContentCloneRequestVNext
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<PublicEmail>>
- Defined in codegen/marketing/emails/types/PromiseAPI.ts:78

create

create(emailCreateRequest, _options?): Promise<PublicEmail>
Use this endpoint to create a new marketing email. Create a new marketing email.
Parameters
- emailCreateRequest: EmailCreateRequest
- Optional_options: PromiseConfigurationOptions
Returns Promise<PublicEmail>
- Defined in codegen/marketing/emails/types/PromiseAPI.ts:144

createAbTestVariation

createAbTestVariation(abTestCreateRequestVNext, _options?): Promise<PublicEmail>
Create a variation of a marketing email for an A/B test. The new variation will be created as a draft. If an active variation already exists, a new one won't be created. Create an A/B test variation of a marketing email.
Parameters
- abTestCreateRequestVNext: AbTestCreateRequestVNext
- Optional_options: PromiseConfigurationOptions
Returns Promise<PublicEmail>
- Defined in codegen/marketing/emails/types/PromiseAPI.ts:188

createAbTestVariationWithHttpInfo

createAbTestVariationWithHttpInfo(abTestCreateRequestVNext, _options?): Promise<HttpInfo<PublicEmail>>
Create a variation of a marketing email for an A/B test. The new variation will be created as a draft. If an active variation already exists, a new one won't be created. Create an A/B test variation of a marketing email.
Parameters
- abTestCreateRequestVNext: AbTestCreateRequestVNext
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<PublicEmail>>
- Defined in codegen/marketing/emails/types/PromiseAPI.ts:166

createWithHttpInfo

createWithHttpInfo(emailCreateRequest, _options?): Promise<HttpInfo<PublicEmail>>
Use this endpoint to create a new marketing email. Create a new marketing email.
Parameters
- emailCreateRequest: EmailCreateRequest
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<PublicEmail>>
- Defined in codegen/marketing/emails/types/PromiseAPI.ts:122

getAbTestVariation

getAbTestVariation(emailId, _options?): Promise<PublicEmail>
This endpoint lets you obtain the variation of an A/B marketing email. If the email is variation A (master) it will return variation B (variant) and vice versa. Get the variation of a an A/B marketing email
Parameters
- emailId: string
  The ID of an A/B marketing email.
- Optional_options: PromiseConfigurationOptions
Returns Promise<PublicEmail>
- Defined in codegen/marketing/emails/types/PromiseAPI.ts:232

getAbTestVariationWithHttpInfo

getAbTestVariationWithHttpInfo(emailId, _options?): Promise<HttpInfo<PublicEmail>>
This endpoint lets you obtain the variation of an A/B marketing email. If the email is variation A (master) it will return variation B (variant) and vice versa. Get the variation of a an A/B marketing email
Parameters
- emailId: string
  The ID of an A/B marketing email.
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<PublicEmail>>
- Defined in codegen/marketing/emails/types/PromiseAPI.ts:210

getById

getById(emailId, includeStats?, marketingCampaignNames?, workflowNames?, includedProperties?, archived?, _options?): Promise<PublicEmail>
Get the details for a marketing email. Get the details of a specified marketing email.
Parameters
- emailId: string
  The marketing email ID.
- OptionalincludeStats: boolean
  Include statistics with email
- OptionalmarketingCampaignNames: boolean
- OptionalworkflowNames: boolean
- OptionalincludedProperties: string[]
- Optionalarchived: boolean
  Whether to return only results that have been archived.
- Optional_options: PromiseConfigurationOptions
Returns Promise<PublicEmail>
- Defined in codegen/marketing/emails/types/PromiseAPI.ts:286

getByIdWithHttpInfo

getByIdWithHttpInfo(emailId, includeStats?, marketingCampaignNames?, workflowNames?, includedProperties?, archived?, _options?): Promise<HttpInfo<PublicEmail>>
Get the details for a marketing email. Get the details of a specified marketing email.
Parameters
- emailId: string
  The marketing email ID.
- OptionalincludeStats: boolean
  Include statistics with email
- OptionalmarketingCampaignNames: boolean
- OptionalworkflowNames: boolean
- OptionalincludedProperties: string[]
- Optionalarchived: boolean
  Whether to return only results that have been archived.
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<PublicEmail>>
- Defined in codegen/marketing/emails/types/PromiseAPI.ts:259

getDraft

getDraft(emailId, _options?): Promise<PublicEmail>
Get the draft version of an email (if it exists). If no draft version exists, the published email is returned. Get draft version of a marketing email
Parameters
- emailId: string
  The marketing email ID.
- Optional_options: PromiseConfigurationOptions
Returns Promise<PublicEmail>
- Defined in codegen/marketing/emails/types/PromiseAPI.ts:330

getDraftWithHttpInfo

getDraftWithHttpInfo(emailId, _options?): Promise<HttpInfo<PublicEmail>>
Get the draft version of an email (if it exists). If no draft version exists, the published email is returned. Get draft version of a marketing email
Parameters
- emailId: string
  The marketing email ID.
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<PublicEmail>>
- Defined in codegen/marketing/emails/types/PromiseAPI.ts:308

getPage

getPage(createdAt?, createdAfter?, createdBefore?, updatedAt?, updatedAfter?, updatedBefore?, sort?, after?, limit?, includeStats?, marketingCampaignNames?, workflowNames?, type?, isPublished?, includedProperties?, campaign?, archived?, _options?): Promise<CollectionResponseWithTotalPublicEmailForwardPaging>
The results can be filtered, allowing you to find a specific set of emails. See the table below for a full list of filtering options. Get all marketing emails for a HubSpot account.
Parameters
- OptionalcreatedAt: Date
  Only return emails created at exactly the specified time.
- OptionalcreatedAfter: Date
  Only return emails created after the specified time.
- OptionalcreatedBefore: Date
  Only return emails created before the specified time.
- OptionalupdatedAt: Date
  Only return emails last updated at exactly the specified time.
- OptionalupdatedAfter: Date
  Only return emails last updated after the specified time.
- OptionalupdatedBefore: Date
  Only return emails last updated before the specified time.
- Optionalsort: string[]
  Specifies which fields to use for sorting results. Valid fields are `name`, `createdAt`, `updatedAt`, `createdBy`, `updatedBy`. `createdAt` will be used by default.
- Optionalafter: string
  The cursor token value to get the next set of results. You can get this from the `paging.next.after` JSON property of a paged response containing more results.
- Optionallimit: number
  The maximum number of results to return. Default is 100.
- OptionalincludeStats: boolean
  Include statistics with emails.
- OptionalmarketingCampaignNames: boolean
- OptionalworkflowNames: boolean
- Optionaltype:
      | "AB_EMAIL"
      | "BATCH_EMAIL"
      | "LOCALTIME_EMAIL"
      | "AUTOMATED_AB_EMAIL"
      | "BLOG_EMAIL"
      | "BLOG_EMAIL_CHILD"
      | "RSS_EMAIL"
      | "RSS_EMAIL_CHILD"
      | "RESUBSCRIBE_EMAIL"
      | "OPTIN_EMAIL"
      | "OPTIN_FOLLOWUP_EMAIL"
      | "AUTOMATED_EMAIL"
      | "FEEDBACK_CES_EMAIL"
      | "FEEDBACK_CUSTOM_EMAIL"
      | "FEEDBACK_CUSTOM_SURVEY_EMAIL"
      | "FEEDBACK_NPS_EMAIL"
      | "FOLLOWUP_EMAIL"
      | "LEADFLOW_EMAIL"
      | "SINGLE_SEND_API"
      | "MARKETING_SINGLE_SEND_API"
      | "SMTP_TOKEN"
      | "TICKET_EMAIL"
      | "MEMBERSHIP_REGISTRATION_EMAIL"
      | "MEMBERSHIP_PASSWORD_SAVED_EMAIL"
      | "MEMBERSHIP_PASSWORD_RESET_EMAIL"
      | "MEMBERSHIP_EMAIL_VERIFICATION_EMAIL"
      | "MEMBERSHIP_PASSWORDLESS_AUTH_EMAIL"
      | "MEMBERSHIP_REGISTRATION_FOLLOW_UP_EMAIL"
      | "MEMBERSHIP_OTP_LOGIN_EMAIL"
      | "MEMBERSHIP_FOLLOW_UP_EMAIL"
      | "MEMBERSHIP_VERIFICATION_EMAIL"
  Email types to be filtered by. Multiple types can be included. All emails will be returned if not present.
- OptionalisPublished: boolean
  Filter by published/draft emails. All emails will be returned if not present.
- OptionalincludedProperties: string[]
- Optionalcampaign: string
  Filter by campaign GUID. All emails will be returned if not present.
- Optionalarchived: boolean
  Specifies whether to return archived emails. Defaults to `false`.
- Optional_options: PromiseConfigurationOptions
Returns Promise<CollectionResponseWithTotalPublicEmailForwardPaging>
- Defined in codegen/marketing/emails/types/PromiseAPI.ts:406

getPageWithHttpInfo

getPageWithHttpInfo(createdAt?, createdAfter?, createdBefore?, updatedAt?, updatedAfter?, updatedBefore?, sort?, after?, limit?, includeStats?, marketingCampaignNames?, workflowNames?, type?, isPublished?, includedProperties?, campaign?, archived?, _options?): Promise<HttpInfo<CollectionResponseWithTotalPublicEmailForwardPaging>>
The results can be filtered, allowing you to find a specific set of emails. See the table below for a full list of filtering options. Get all marketing emails for a HubSpot account.
Parameters
- OptionalcreatedAt: Date
  Only return emails created at exactly the specified time.
- OptionalcreatedAfter: Date
  Only return emails created after the specified time.
- OptionalcreatedBefore: Date
  Only return emails created before the specified time.
- OptionalupdatedAt: Date
  Only return emails last updated at exactly the specified time.
- OptionalupdatedAfter: Date
  Only return emails last updated after the specified time.
- OptionalupdatedBefore: Date
  Only return emails last updated before the specified time.
- Optionalsort: string[]
  Specifies which fields to use for sorting results. Valid fields are `name`, `createdAt`, `updatedAt`, `createdBy`, `updatedBy`. `createdAt` will be used by default.
- Optionalafter: string
  The cursor token value to get the next set of results. You can get this from the `paging.next.after` JSON property of a paged response containing more results.
- Optionallimit: number
  The maximum number of results to return. Default is 100.
- OptionalincludeStats: boolean
  Include statistics with emails.
- OptionalmarketingCampaignNames: boolean
- OptionalworkflowNames: boolean
- Optionaltype:
      | "AB_EMAIL"
      | "BATCH_EMAIL"
      | "LOCALTIME_EMAIL"
      | "AUTOMATED_AB_EMAIL"
      | "BLOG_EMAIL"
      | "BLOG_EMAIL_CHILD"
      | "RSS_EMAIL"
      | "RSS_EMAIL_CHILD"
      | "RESUBSCRIBE_EMAIL"
      | "OPTIN_EMAIL"
      | "OPTIN_FOLLOWUP_EMAIL"
      | "AUTOMATED_EMAIL"
      | "FEEDBACK_CES_EMAIL"
      | "FEEDBACK_CUSTOM_EMAIL"
      | "FEEDBACK_CUSTOM_SURVEY_EMAIL"
      | "FEEDBACK_NPS_EMAIL"
      | "FOLLOWUP_EMAIL"
      | "LEADFLOW_EMAIL"
      | "SINGLE_SEND_API"
      | "MARKETING_SINGLE_SEND_API"
      | "SMTP_TOKEN"
      | "TICKET_EMAIL"
      | "MEMBERSHIP_REGISTRATION_EMAIL"
      | "MEMBERSHIP_PASSWORD_SAVED_EMAIL"
      | "MEMBERSHIP_PASSWORD_RESET_EMAIL"
      | "MEMBERSHIP_EMAIL_VERIFICATION_EMAIL"
      | "MEMBERSHIP_PASSWORDLESS_AUTH_EMAIL"
      | "MEMBERSHIP_REGISTRATION_FOLLOW_UP_EMAIL"
      | "MEMBERSHIP_OTP_LOGIN_EMAIL"
      | "MEMBERSHIP_FOLLOW_UP_EMAIL"
      | "MEMBERSHIP_VERIFICATION_EMAIL"
  Email types to be filtered by. Multiple types can be included. All emails will be returned if not present.
- OptionalisPublished: boolean
  Filter by published/draft emails. All emails will be returned if not present.
- OptionalincludedProperties: string[]
- Optionalcampaign: string
  Filter by campaign GUID. All emails will be returned if not present.
- Optionalarchived: boolean
  Specifies whether to return archived emails. Defaults to `false`.
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<CollectionResponseWithTotalPublicEmailForwardPaging>>
- Defined in codegen/marketing/emails/types/PromiseAPI.ts:368

getRevisionById

getRevisionById(emailId, revisionId, _options?): Promise<VersionPublicEmail>
Get a specific revision of a marketing email. Get a revision of a marketing email.
Parameters
- emailId: string
  The marketing email ID.
- revisionId: string
  The ID of a revision.
- Optional_options: PromiseConfigurationOptions
Returns Promise<VersionPublicEmail>
- Defined in codegen/marketing/emails/types/PromiseAPI.ts:452

getRevisionByIdWithHttpInfo

getRevisionByIdWithHttpInfo(emailId, revisionId, _options?): Promise<HttpInfo<VersionPublicEmail>>
Get a specific revision of a marketing email. Get a revision of a marketing email.
Parameters
- emailId: string
  The marketing email ID.
- revisionId: string
  The ID of a revision.
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<VersionPublicEmail>>
- Defined in codegen/marketing/emails/types/PromiseAPI.ts:429

getRevisions

getRevisions(emailId, after?, before?, limit?, _options?): Promise<CollectionResponseWithTotalVersionPublicEmail>
Get a list of all versions of a marketing email, with each entry including the full state of that particular version. The current revision has the ID -1. Get revisions of a marketing email
Parameters
- emailId: string
  The marketing email ID.
- Optionalafter: string
  The cursor token value to get the next set of results. You can get this from the `paging.next.after` JSON property of a paged response containing more results.
- Optionalbefore: string
  The cursor token value to get the previous set of results. You can get this from the `paging.prev.before` JSON property of a paged response containing more results.
- Optionallimit: number
  The maximum number of results to return. Default is 100.
- Optional_options: PromiseConfigurationOptions
Returns Promise<CollectionResponseWithTotalVersionPublicEmail>
- Defined in codegen/marketing/emails/types/PromiseAPI.ts:502

getRevisionsWithHttpInfo

getRevisionsWithHttpInfo(emailId, after?, before?, limit?, _options?): Promise<HttpInfo<CollectionResponseWithTotalVersionPublicEmail>>
Get a list of all versions of a marketing email, with each entry including the full state of that particular version. The current revision has the ID -1. Get revisions of a marketing email
Parameters
- emailId: string
  The marketing email ID.
- Optionalafter: string
  The cursor token value to get the next set of results. You can get this from the `paging.next.after` JSON property of a paged response containing more results.
- Optionalbefore: string
  The cursor token value to get the previous set of results. You can get this from the `paging.prev.before` JSON property of a paged response containing more results.
- Optionallimit: number
  The maximum number of results to return. Default is 100.
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<CollectionResponseWithTotalVersionPublicEmail>>
- Defined in codegen/marketing/emails/types/PromiseAPI.ts:477

publishOrSend

publishOrSend(emailId, _options?): Promise<void>
If you have a Marketing Hub Enterprise account or the transactional email add-on, you can use this endpoint to publish an automated email or send/schedule a regular email. Publish or send a marketing email.
Parameters
- emailId: string
- Optional_options: PromiseConfigurationOptions
Returns Promise<void>
- Defined in codegen/marketing/emails/types/PromiseAPI.ts:546

publishOrSendWithHttpInfo

publishOrSendWithHttpInfo(emailId, _options?): Promise<HttpInfo<void>>
If you have a Marketing Hub Enterprise account or the transactional email add-on, you can use this endpoint to publish an automated email or send/schedule a regular email. Publish or send a marketing email.
Parameters
- emailId: string
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<void>>
- Defined in codegen/marketing/emails/types/PromiseAPI.ts:524

resetDraft

resetDraft(emailId, _options?): Promise<void>
Resets the draft back to a copy of the live object. Reset Draft
Parameters
- emailId: string
  The marketing email ID.
- Optional_options: PromiseConfigurationOptions
Returns Promise<void>
- Defined in codegen/marketing/emails/types/PromiseAPI.ts:590

resetDraftWithHttpInfo

resetDraftWithHttpInfo(emailId, _options?): Promise<HttpInfo<void>>
Resets the draft back to a copy of the live object. Reset Draft
Parameters
- emailId: string
  The marketing email ID.
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<void>>
- Defined in codegen/marketing/emails/types/PromiseAPI.ts:568

restoreDraftRevision

restoreDraftRevision(emailId, revisionId, _options?): Promise<PublicEmail>
Restores a previous revision of a marketing email to DRAFT state. If there is currently something in the draft for that object, it is overwritten. Restore a revision of a marketing email to DRAFT state
Parameters
- emailId: string
  The marketing email ID.
- revisionId: number
  The ID of a revision.
- Optional_options: PromiseConfigurationOptions
Returns Promise<PublicEmail>
- Defined in codegen/marketing/emails/types/PromiseAPI.ts:636

restoreDraftRevisionWithHttpInfo

restoreDraftRevisionWithHttpInfo(emailId, revisionId, _options?): Promise<HttpInfo<PublicEmail>>
Restores a previous revision of a marketing email to DRAFT state. If there is currently something in the draft for that object, it is overwritten. Restore a revision of a marketing email to DRAFT state
Parameters
- emailId: string
  The marketing email ID.
- revisionId: number
  The ID of a revision.
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<PublicEmail>>
- Defined in codegen/marketing/emails/types/PromiseAPI.ts:613

restoreRevision

restoreRevision(emailId, revisionId, _options?): Promise<void>
Restores a previous revision of a marketing email. The current revision becomes old, and the restored revision is given a new version number. Restore a revision of a marketing email
Parameters
- emailId: string
  The marketing email ID.
- revisionId: string
  The ID of a revision.
- Optional_options: PromiseConfigurationOptions
Returns Promise<void>
- Defined in codegen/marketing/emails/types/PromiseAPI.ts:682

restoreRevisionWithHttpInfo

restoreRevisionWithHttpInfo(emailId, revisionId, _options?): Promise<HttpInfo<void>>
Restores a previous revision of a marketing email. The current revision becomes old, and the restored revision is given a new version number. Restore a revision of a marketing email
Parameters
- emailId: string
  The marketing email ID.
- revisionId: string
  The ID of a revision.
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<void>>
- Defined in codegen/marketing/emails/types/PromiseAPI.ts:659

unpublishOrCancel

unpublishOrCancel(emailId, _options?): Promise<void>
If you have a Marketing Hub Enterprise account or the transactional email add-on, you can use this endpoint to unpublish an automated email or cancel a regular email. If the email is already in the process of being sent, canceling might not be possible. Unpublish or cancel a marketing email.
Parameters
- emailId: string
- Optional_options: PromiseConfigurationOptions
Returns Promise<void>
- Defined in codegen/marketing/emails/types/PromiseAPI.ts:726

unpublishOrCancelWithHttpInfo

unpublishOrCancelWithHttpInfo(emailId, _options?): Promise<HttpInfo<void>>
If you have a Marketing Hub Enterprise account or the transactional email add-on, you can use this endpoint to unpublish an automated email or cancel a regular email. If the email is already in the process of being sent, canceling might not be possible. Unpublish or cancel a marketing email.
Parameters
- emailId: string
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<void>>
- Defined in codegen/marketing/emails/types/PromiseAPI.ts:704

update

update(emailId, emailUpdateRequest, archived?, _options?): Promise<PublicEmail>
Change properties of a marketing email. Update a marketing email.
Parameters
- emailId: string
  The ID of the marketing email that should get updated
- emailUpdateRequest: EmailUpdateRequest
  A marketing email object with properties that should overwrite the corresponding properties of the marketing email.
- Optionalarchived: boolean
  Whether to return only results that have been archived.
- Optional_options: PromiseConfigurationOptions
Returns Promise<PublicEmail>
- Defined in codegen/marketing/emails/types/PromiseAPI.ts:774

updateWithHttpInfo

updateWithHttpInfo(emailId, emailUpdateRequest, archived?, _options?): Promise<HttpInfo<PublicEmail>>
Change properties of a marketing email. Update a marketing email.
Parameters
- emailId: string
  The ID of the marketing email that should get updated
- emailUpdateRequest: EmailUpdateRequest
  A marketing email object with properties that should overwrite the corresponding properties of the marketing email.
- Optionalarchived: boolean
  Whether to return only results that have been archived.
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<PublicEmail>>
- Defined in codegen/marketing/emails/types/PromiseAPI.ts:750

upsertDraft

upsertDraft(emailId, emailUpdateRequest, _options?): Promise<PublicEmail>
Create or update the draft version of a marketing email. If no draft exists, the system creates a draft from the current “live” email then applies the request body to that draft. The draft version only lives on the buffer—the email is not cloned. Create or update draft version
Parameters
- emailId: string
  The marketing email ID.
- emailUpdateRequest: EmailUpdateRequest
  A marketing email object with properties that should overwrite the corresponding properties in the email's current draft.
- Optional_options: PromiseConfigurationOptions
Returns Promise<PublicEmail>
- Defined in codegen/marketing/emails/types/PromiseAPI.ts:820

upsertDraftWithHttpInfo

upsertDraftWithHttpInfo(emailId, emailUpdateRequest, _options?): Promise<HttpInfo<PublicEmail>>
Create or update the draft version of a marketing email. If no draft exists, the system creates a draft from the current “live” email then applies the request body to that draft. The draft version only lives on the buffer—the email is not cloned. Create or update draft version
Parameters
- emailId: string
  The marketing email ID.
- emailUpdateRequest: EmailUpdateRequest
  A marketing email object with properties that should overwrite the corresponding properties in the email's current draft.
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<PublicEmail>>
- Defined in codegen/marketing/emails/types/PromiseAPI.ts:797

Class MarketingEmailsApi

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns MarketingEmailsApi

Methods

archive

Parameters

Returns Promise<void>

archiveWithHttpInfo

Parameters

Returns Promise<HttpInfo<void>>

clone

Parameters

Returns Promise<PublicEmail>

cloneWithHttpInfo

Parameters

Returns Promise<HttpInfo<PublicEmail>>

create

Parameters

Returns Promise<PublicEmail>

createAbTestVariation

Parameters

Returns Promise<PublicEmail>

createAbTestVariationWithHttpInfo

Parameters

Returns Promise<HttpInfo<PublicEmail>>

createWithHttpInfo

Parameters

Returns Promise<HttpInfo<PublicEmail>>

getAbTestVariation

Parameters

Returns Promise<PublicEmail>

getAbTestVariationWithHttpInfo

Parameters

Returns Promise<HttpInfo<PublicEmail>>

getById

Parameters

Returns Promise<PublicEmail>

getByIdWithHttpInfo

Parameters

Returns Promise<HttpInfo<PublicEmail>>

getDraft

Parameters

Returns Promise<PublicEmail>

getDraftWithHttpInfo

Parameters

Returns Promise<HttpInfo<PublicEmail>>

getPage

Parameters

Returns Promise<CollectionResponseWithTotalPublicEmailForwardPaging>

getPageWithHttpInfo

Parameters

Returns Promise<HttpInfo<CollectionResponseWithTotalPublicEmailForwardPaging>>

getRevisionById

Parameters

Returns Promise<VersionPublicEmail>

getRevisionByIdWithHttpInfo

Parameters

Returns Promise<HttpInfo<VersionPublicEmail>>

getRevisions

Parameters

Returns Promise<CollectionResponseWithTotalVersionPublicEmail>

getRevisionsWithHttpInfo

Parameters

Returns Promise<HttpInfo<CollectionResponseWithTotalVersionPublicEmail>>

publishOrSend

Parameters

Returns Promise<void>

publishOrSendWithHttpInfo

Parameters

Returns Promise<HttpInfo<void>>

resetDraft

Parameters

Returns Promise<void>

resetDraftWithHttpInfo

Parameters