Class AddEventAttendeesApi

Constructors

constructor

Methods

recordByContactEmails recordByContactEmailsWithHttpInfo recordByContactId recordByContactIds recordByContactIdsWithHttpInfo recordByContactIdWithHttpInfo recordByEmail recordByEmailWithHttpInfo

Constructors

constructor

Methods

recordByContactEmails

  • recordByContactEmails(externalEventId, subscriberState, batchInputMarketingEventEmailSubscriber, externalAccountId?, _options?): Promise<BatchResponseSubscriberEmailResponse>

  • Records the participation of multiple HubSpot contacts in a Marketing Event using their email addresses. If a contact does not exist, it will be automatically created. The contactProperties field is used exclusively for creating new contacts and will not update properties of existing contacts. Additional Functionality: - Adds a timeline event to the contacts. Allowed Properties: For the state "attend": - joinedAt - leftAt Record Participants by Email with Marketing Event External Ids

    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;.

    • batchInputMarketingEventEmailSubscriber: BatchInputMarketingEventEmailSubscriber
    • OptionalexternalAccountId: string

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

    • Optional_options: PromiseConfigurationOptions

    Returns Promise<BatchResponseSubscriberEmailResponse>

recordByContactEmailsWithHttpInfo

  • recordByContactEmailsWithHttpInfo(externalEventId, subscriberState, batchInputMarketingEventEmailSubscriber, externalAccountId?, _options?): Promise<HttpInfo<BatchResponseSubscriberEmailResponse>>

  • Records the participation of multiple HubSpot contacts in a Marketing Event using their email addresses. If a contact does not exist, it will be automatically created. The contactProperties field is used exclusively for creating new contacts and will not update properties of existing contacts. Additional Functionality: - Adds a timeline event to the contacts. Allowed Properties: For the state "attend": - joinedAt - leftAt Record Participants by Email with Marketing Event External Ids

    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;.

    • batchInputMarketingEventEmailSubscriber: BatchInputMarketingEventEmailSubscriber
    • OptionalexternalAccountId: string

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

    • Optional_options: PromiseConfigurationOptions

    Returns Promise<HttpInfo<BatchResponseSubscriberEmailResponse>>

recordByContactId

recordByContactIds

  • recordByContactIds(externalEventId, subscriberState, batchInputMarketingEventSubscriber, externalAccountId?, _options?): Promise<BatchResponseSubscriberVidResponse>

  • Records the participation of multiple HubSpot contacts in a Marketing Event using their HubSpot contact IDs. Additional Functionality: - Adds a timeline event to the contacts. Allowed Properties: For the state "attend": - joinedAt - leftAt Record Participants by ContactId with Marketing Event External Ids

    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;.

    • batchInputMarketingEventSubscriber: BatchInputMarketingEventSubscriber
    • OptionalexternalAccountId: string

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

    • Optional_options: PromiseConfigurationOptions

    Returns Promise<BatchResponseSubscriberVidResponse>

recordByContactIdsWithHttpInfo

  • recordByContactIdsWithHttpInfo(externalEventId, subscriberState, batchInputMarketingEventSubscriber, externalAccountId?, _options?): Promise<HttpInfo<BatchResponseSubscriberVidResponse>>

  • Records the participation of multiple HubSpot contacts in a Marketing Event using their HubSpot contact IDs. Additional Functionality: - Adds a timeline event to the contacts. Allowed Properties: For the state "attend": - joinedAt - leftAt Record Participants by ContactId with Marketing Event External Ids

    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;.

    • batchInputMarketingEventSubscriber: BatchInputMarketingEventSubscriber
    • OptionalexternalAccountId: string

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

    • Optional_options: PromiseConfigurationOptions

    Returns Promise<HttpInfo<BatchResponseSubscriberVidResponse>>

recordByContactIdWithHttpInfo

recordByEmail

  • recordByEmail(objectId, subscriberState, batchInputMarketingEventEmailSubscriber, _options?): Promise<BatchResponseSubscriberEmailResponse>

  • Records the participation of multiple HubSpot contacts in a Marketing Event using their email addresses. If a contact does not exist, it will be automatically created. The contactProperties field is used exclusively for creating new contacts and will not update properties of existing contacts. Additional Functionality: - Adds a timeline event to the contacts. Allowed Properties: For the state "attend": - joinedAt - leftAt Record Participants by Email with Marketing Event Object Id

    Parameters

    Returns Promise<BatchResponseSubscriberEmailResponse>

recordByEmailWithHttpInfo

  • recordByEmailWithHttpInfo(objectId, subscriberState, batchInputMarketingEventEmailSubscriber, _options?): Promise<HttpInfo<BatchResponseSubscriberEmailResponse>>

  • Records the participation of multiple HubSpot contacts in a Marketing Event using their email addresses. If a contact does not exist, it will be automatically created. The contactProperties field is used exclusively for creating new contacts and will not update properties of existing contacts. Additional Functionality: - Adds a timeline event to the contacts. Allowed Properties: For the state "attend": - joinedAt - leftAt Record Participants by Email with Marketing Event Object Id

    Parameters

    Returns Promise<HttpInfo<BatchResponseSubscriberEmailResponse>>

Settings

Member Visibility

On This Page

Constructors
Methods