Class SubscriberStateChangesApi

Constructors

constructor

Methods

upsertByContactEmail upsertByContactEmailWithHttpInfo upsertByContactId upsertByContactIdWithHttpInfo

Constructors

constructor

Methods

upsertByContactEmail

  • upsertByContactEmail(externalEventId, subscriberState, externalAccountId, batchInputMarketingEventEmailSubscriber, _options?): Promise<void>

  • Record a subscriber state between multiple HubSpot contacts and a marketing event, using contact email addresses. Note that the contact must already exist in HubSpot; a contact will not be created. The contactProperties field is used only when creating a new contact. These properties will not update existing contacts. Record a subscriber state by contact email

    Parameters

    • externalEventId: string

      The id of the marketing event in the external event application

    • subscriberState: string

      The new subscriber state for the HubSpot contacts and the specified marketing event. For example: &#39;register&#39;, &#39;attend&#39; or &#39;cancel&#39;.

    • externalAccountId: string

      The accountId that is associated with this marketing event in the external event application

    • batchInputMarketingEventEmailSubscriber: BatchInputMarketingEventEmailSubscriber
    • Optional_options: PromiseConfigurationOptions

    Returns Promise<void>

upsertByContactEmailWithHttpInfo

  • upsertByContactEmailWithHttpInfo(externalEventId, subscriberState, externalAccountId, batchInputMarketingEventEmailSubscriber, _options?): Promise<HttpInfo<void>>

  • Record a subscriber state between multiple HubSpot contacts and a marketing event, using contact email addresses. Note that the contact must already exist in HubSpot; a contact will not be created. The contactProperties field is used only when creating a new contact. These properties will not update existing contacts. Record a subscriber state by contact email

    Parameters

    • externalEventId: string

      The id of the marketing event in the external event application

    • subscriberState: string

      The new subscriber state for the HubSpot contacts and the specified marketing event. For example: &#39;register&#39;, &#39;attend&#39; or &#39;cancel&#39;.

    • externalAccountId: string

      The accountId that is associated with this marketing event in the external event application

    • batchInputMarketingEventEmailSubscriber: BatchInputMarketingEventEmailSubscriber
    • Optional_options: PromiseConfigurationOptions

    Returns Promise<HttpInfo<void>>

upsertByContactId

  • upsertByContactId(externalEventId, subscriberState, externalAccountId, batchInputMarketingEventSubscriber, _options?): Promise<void>

  • Record a subscriber state between multiple HubSpot contacts and a marketing event, using HubSpot contact IDs. Note that the contact must already exist in HubSpot; a contact will not be created. Record a subscriber state by contact ID

    Parameters

    • externalEventId: string

      The id of the marketing event in the external event application

    • subscriberState: string

      The new subscriber state for the HubSpot contacts and the specified marketing event. For example: &#39;register&#39;, &#39;attend&#39; or &#39;cancel&#39;.

    • externalAccountId: string

      The accountId that is associated with this marketing event in the external event application

    • batchInputMarketingEventSubscriber: BatchInputMarketingEventSubscriber
    • Optional_options: PromiseConfigurationOptions

    Returns Promise<void>

upsertByContactIdWithHttpInfo

  • upsertByContactIdWithHttpInfo(externalEventId, subscriberState, externalAccountId, batchInputMarketingEventSubscriber, _options?): Promise<HttpInfo<void>>

  • Record a subscriber state between multiple HubSpot contacts and a marketing event, using HubSpot contact IDs. Note that the contact must already exist in HubSpot; a contact will not be created. Record a subscriber state by contact ID

    Parameters

    • externalEventId: string

      The id of the marketing event in the external event application

    • subscriberState: string

      The new subscriber state for the HubSpot contacts and the specified marketing event. For example: &#39;register&#39;, &#39;attend&#39; or &#39;cancel&#39;.

    • externalAccountId: string

      The accountId that is associated with this marketing event in the external event application

    • batchInputMarketingEventSubscriber: BatchInputMarketingEventSubscriber
    • Optional_options: PromiseConfigurationOptions

    Returns Promise<HttpInfo<void>>

Settings

Member Visibility

On This Page

Constructors
Methods