Class IdentifiersApi

Constructors

new IdentifiersApi(configuration, requestFactory?, responseProcessor?): IdentifiersApi
Parameters
- configuration: Configuration<ObservableMiddleware>
- OptionalrequestFactory: IdentifiersApiRequestFactory
- OptionalresponseProcessor: IdentifiersApiResponseProcessor
Returns IdentifiersApi
- Defined in codegen/marketing/events/types/PromiseAPI.ts:991

doSearch(q, _options?): Promise<CollectionResponseSearchPublicResponseWrapperNoPaging>
Retrieves Marketing Events where the externalEventId matches the value provided in the request, limited to events created by the app making the request. Marketing Events created by other apps will not be included in the results. Find App-Specific Marketing Events by External Event Id
Parameters
- q: string
  The id of the marketing event in the external event application (externalEventId)
- Optional_options: PromiseConfigurationOptions
Returns Promise<CollectionResponseSearchPublicResponseWrapperNoPaging>
- Defined in codegen/marketing/events/types/PromiseAPI.ts:1026

doSearchWithHttpInfo(q, _options?): Promise<HttpInfo<CollectionResponseSearchPublicResponseWrapperNoPaging>>
Retrieves Marketing Events where the externalEventId matches the value provided in the request, limited to events created by the app making the request. Marketing Events created by other apps will not be included in the results. Find App-Specific Marketing Events by External Event Id
Parameters
- q: string
  The id of the marketing event in the external event application (externalEventId)
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<CollectionResponseSearchPublicResponseWrapperNoPaging>>
- Defined in codegen/marketing/events/types/PromiseAPI.ts:1004

searchPortalEvents(externalEventId, _options?): Promise<CollectionResponseWithTotalMarketingEventIdentifiersResponseNoPaging>
This endpoint searches the portal for all Marketing Events whose externalEventId matches the value provided in the request. It retrieves the objectId and additional event details for each matching Marketing Event. Since multiple Marketing Events can have the same externalEventId, the endpoint returns all matching results. Note: Marketing Events become searchable by externalEventId a few minutes after creation. Find Marketing Events by External Event Id
Parameters
- externalEventId: string
  The id of the marketing event in the external event application.
- Optional_options: PromiseConfigurationOptions
Returns Promise<CollectionResponseWithTotalMarketingEventIdentifiersResponseNoPaging>
- Defined in codegen/marketing/events/types/PromiseAPI.ts:1070

searchPortalEventsWithHttpInfo(externalEventId, _options?): Promise<HttpInfo<CollectionResponseWithTotalMarketingEventIdentifiersResponseNoPaging>>
This endpoint searches the portal for all Marketing Events whose externalEventId matches the value provided in the request. It retrieves the objectId and additional event details for each matching Marketing Event. Since multiple Marketing Events can have the same externalEventId, the endpoint returns all matching results. Note: Marketing Events become searchable by externalEventId a few minutes after creation. Find Marketing Events by External Event Id
Parameters
- externalEventId: string
  The id of the marketing event in the external event application.
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<CollectionResponseWithTotalMarketingEventIdentifiersResponseNoPaging>>
- Defined in codegen/marketing/events/types/PromiseAPI.ts:1048