Class ListsApi

Index

Constructors

Methods

create createWithHttpInfo doSearch doSearchWithHttpInfo getAll getAllWithHttpInfo getById getByIdWithHttpInfo getByName getByNameWithHttpInfo remove removeWithHttpInfo restore restoreWithHttpInfo updateListFilters updateListFiltersWithHttpInfo updateName updateNameWithHttpInfo

Constructors

constructor

new ListsApi(configuration, requestFactory?, responseProcessor?): ListsApi
Parameters
- configuration: Configuration
- OptionalrequestFactory: ListsApiRequestFactory
- OptionalresponseProcessor: ListsApiResponseProcessor
Returns ListsApi
- Defined in codegen/crm/lists/types/PromiseAPI.ts:171

Methods

create

create(listCreateRequest, _options?): Promise<ListCreateResponse>
Create a new list with the provided object list definition. Create List
Parameters
- listCreateRequest: ListCreateRequest
- Optional_options: Configuration
Returns Promise<ListCreateResponse>
- Defined in codegen/crm/lists/types/PromiseAPI.ts:194

createWithHttpInfo

createWithHttpInfo(listCreateRequest, _options?): Promise<HttpInfo<ListCreateResponse>>
Create a new list with the provided object list definition. Create List
Parameters
- listCreateRequest: ListCreateRequest
- Optional_options: Configuration
Returns Promise<HttpInfo<ListCreateResponse>>
- Defined in codegen/crm/lists/types/PromiseAPI.ts:184

doSearch

doSearch(listSearchRequest, _options?): Promise<ListSearchResponse>
Search lists by list name or page through all lists by providing an empty query value. Search Lists
Parameters
- listSearchRequest: ListSearchRequest
- Optional_options: Configuration
Returns Promise<ListSearchResponse>
- Defined in codegen/crm/lists/types/PromiseAPI.ts:214

doSearchWithHttpInfo

doSearchWithHttpInfo(listSearchRequest, _options?): Promise<HttpInfo<ListSearchResponse>>
Search lists by list name or page through all lists by providing an empty query value. Search Lists
Parameters
- listSearchRequest: ListSearchRequest
- Optional_options: Configuration
Returns Promise<HttpInfo<ListSearchResponse>>
- Defined in codegen/crm/lists/types/PromiseAPI.ts:204

getAll

getAll(listIds?, includeFilters?, _options?): Promise<ListsByIdResponse>
Fetch multiple lists in a single request by ILS list ID. The response will include the definitions of all lists that exist for the listIds provided. Fetch Multiple Lists
Parameters
- OptionallistIds: string[]
  The ILS IDs of the lists to fetch.
- OptionalincludeFilters: boolean
  A flag indicating whether or not the response object list definitions should include a filter branch definition. By default, object list definitions will not have their filter branch definitions included in the response.
- Optional_options: Configuration
Returns Promise<ListsByIdResponse>
- Defined in codegen/crm/lists/types/PromiseAPI.ts:236

getAllWithHttpInfo

getAllWithHttpInfo(listIds?, includeFilters?, _options?): Promise<HttpInfo<ListsByIdResponse>>
Fetch multiple lists in a single request by ILS list ID. The response will include the definitions of all lists that exist for the listIds provided. Fetch Multiple Lists
Parameters
- OptionallistIds: string[]
  The ILS IDs of the lists to fetch.
- OptionalincludeFilters: boolean
  A flag indicating whether or not the response object list definitions should include a filter branch definition. By default, object list definitions will not have their filter branch definitions included in the response.
- Optional_options: Configuration
Returns Promise<HttpInfo<ListsByIdResponse>>
- Defined in codegen/crm/lists/types/PromiseAPI.ts:225

getById

getById(listId, includeFilters?, _options?): Promise<ListFetchResponse>
Fetch a single list by ILS list ID. Fetch List by ID
Parameters
- listId: string
  The ILS ID of the list to fetch.
- OptionalincludeFilters: boolean
  A flag indicating whether or not the response object list definition should include a filter branch definition. By default, object list definitions will not have their filter branch definitions included in the response.
- Optional_options: Configuration
Returns Promise<ListFetchResponse>
- Defined in codegen/crm/lists/types/PromiseAPI.ts:258

getByIdWithHttpInfo

getByIdWithHttpInfo(listId, includeFilters?, _options?): Promise<HttpInfo<ListFetchResponse>>
Fetch a single list by ILS list ID. Fetch List by ID
Parameters
- listId: string
  The ILS ID of the list to fetch.
- OptionalincludeFilters: boolean
  A flag indicating whether or not the response object list definition should include a filter branch definition. By default, object list definitions will not have their filter branch definitions included in the response.
- Optional_options: Configuration
Returns Promise<HttpInfo<ListFetchResponse>>
- Defined in codegen/crm/lists/types/PromiseAPI.ts:247

getByName

getByName(listName, objectTypeId, includeFilters?, _options?): Promise<ListFetchResponse>
Fetch a single list by list name and object type. Fetch List by Name
Parameters
- listName: string
  The name of the list to fetch. This is not case sensitive.
- objectTypeId: string
  The object type ID of the object types stored by the list to fetch. For example, `0-1` for a `CONTACT` list.
- OptionalincludeFilters: boolean
  A flag indicating whether or not the response object list definition should include a filter branch definition. By default, object list definitions will not have their filter branch definitions included in the response.
- Optional_options: Configuration
Returns Promise<ListFetchResponse>
- Defined in codegen/crm/lists/types/PromiseAPI.ts:282

getByNameWithHttpInfo

getByNameWithHttpInfo(listName, objectTypeId, includeFilters?, _options?): Promise<HttpInfo<ListFetchResponse>>
Fetch a single list by list name and object type. Fetch List by Name
Parameters
- listName: string
  The name of the list to fetch. This is not case sensitive.
- objectTypeId: string
  The object type ID of the object types stored by the list to fetch. For example, `0-1` for a `CONTACT` list.
- OptionalincludeFilters: boolean
  A flag indicating whether or not the response object list definition should include a filter branch definition. By default, object list definitions will not have their filter branch definitions included in the response.
- Optional_options: Configuration
Returns Promise<HttpInfo<ListFetchResponse>>
- Defined in codegen/crm/lists/types/PromiseAPI.ts:270

remove

remove(listId, _options?): Promise<void>
Delete a list by ILS list ID. Lists deleted through this endpoint can be restored up to 90-days following the delete. After 90-days, the list is purged and can no longer be restored. Delete a List
Parameters
- listId: string
  The ILS ID of the list to delete.
- Optional_options: Configuration
Returns Promise<void>
- Defined in codegen/crm/lists/types/PromiseAPI.ts:302

removeWithHttpInfo

removeWithHttpInfo(listId, _options?): Promise<HttpInfo<void>>
Delete a list by ILS list ID. Lists deleted through this endpoint can be restored up to 90-days following the delete. After 90-days, the list is purged and can no longer be restored. Delete a List
Parameters
- listId: string
  The ILS ID of the list to delete.
- Optional_options: Configuration
Returns Promise<HttpInfo<void>>
- Defined in codegen/crm/lists/types/PromiseAPI.ts:292

restore

restore(listId, _options?): Promise<void>
Restore a previously deleted list by ILS list ID. Deleted lists are eligible to be restored up-to 90-days after the list has been deleted. Restore a List
Parameters
- listId: string
  The ILS ID of the list to restore.
- Optional_options: Configuration
Returns Promise<void>
- Defined in codegen/crm/lists/types/PromiseAPI.ts:322

restoreWithHttpInfo

restoreWithHttpInfo(listId, _options?): Promise<HttpInfo<void>>
Restore a previously deleted list by ILS list ID. Deleted lists are eligible to be restored up-to 90-days after the list has been deleted. Restore a List
Parameters
- listId: string
  The ILS ID of the list to restore.
- Optional_options: Configuration
Returns Promise<HttpInfo<void>>
- Defined in codegen/crm/lists/types/PromiseAPI.ts:312

updateListFilters

updateListFilters(listId, listFilterUpdateRequest, enrollObjectsInWorkflows?, _options?): Promise<ListUpdateResponse>
Update the filter branch definition of a DYNAMIC list. Once updated, the list memberships will be re-evaluated and updated to match the new definition. Update List Filter Definition
Parameters
- listId: string
  The ILS ID of the list to update.
- listFilterUpdateRequest: ListFilterUpdateRequest
- OptionalenrollObjectsInWorkflows: boolean
  A flag indicating whether or not the memberships added to the list as a result of the filter change should be enrolled in workflows that are relevant to this list.
- Optional_options: Configuration
Returns Promise<ListUpdateResponse>
- Defined in codegen/crm/lists/types/PromiseAPI.ts:346

updateListFiltersWithHttpInfo

updateListFiltersWithHttpInfo(listId, listFilterUpdateRequest, enrollObjectsInWorkflows?, _options?): Promise<HttpInfo<ListUpdateResponse>>
Update the filter branch definition of a DYNAMIC list. Once updated, the list memberships will be re-evaluated and updated to match the new definition. Update List Filter Definition
Parameters
- listId: string
  The ILS ID of the list to update.
- listFilterUpdateRequest: ListFilterUpdateRequest
- OptionalenrollObjectsInWorkflows: boolean
  A flag indicating whether or not the memberships added to the list as a result of the filter change should be enrolled in workflows that are relevant to this list.
- Optional_options: Configuration
Returns Promise<HttpInfo<ListUpdateResponse>>
- Defined in codegen/crm/lists/types/PromiseAPI.ts:334

updateName

updateName(listId, listName?, includeFilters?, _options?): Promise<ListUpdateResponse>
Update the name of a list. The name must be globally unique relative to all other public lists in the portal. Update List Name
Parameters
- listId: string
  The ILS ID of the list to update.
- OptionallistName: string
  The name to update the list to.
- OptionalincludeFilters: boolean
  A flag indicating whether or not the response object list definition should include a filter branch definition. By default, object list definitions will not have their filter branch definitions included in the response.
- Optional_options: Configuration
Returns Promise<ListUpdateResponse>
- Defined in codegen/crm/lists/types/PromiseAPI.ts:370

updateNameWithHttpInfo

updateNameWithHttpInfo(listId, listName?, includeFilters?, _options?): Promise<HttpInfo<ListUpdateResponse>>
Update the name of a list. The name must be globally unique relative to all other public lists in the portal. Update List Name
Parameters
- listId: string
  The ILS ID of the list to update.
- OptionallistName: string
  The name to update the list to.
- OptionalincludeFilters: boolean
  A flag indicating whether or not the response object list definition should include a filter branch definition. By default, object list definitions will not have their filter branch definitions included in the response.
- Optional_options: Configuration
Returns Promise<HttpInfo<ListUpdateResponse>>
- Defined in codegen/crm/lists/types/PromiseAPI.ts:358

Class ListsApi

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns ListsApi

Methods

create

Parameters

Returns Promise<ListCreateResponse>

createWithHttpInfo

Parameters

Returns Promise<HttpInfo<ListCreateResponse>>

doSearch

Parameters

Returns Promise<ListSearchResponse>

doSearchWithHttpInfo

Parameters

Returns Promise<HttpInfo<ListSearchResponse>>

getAll

Parameters

Returns Promise<ListsByIdResponse>

getAllWithHttpInfo

Parameters

Returns Promise<HttpInfo<ListsByIdResponse>>

getById

Parameters

Returns Promise<ListFetchResponse>

getByIdWithHttpInfo

Parameters

Returns Promise<HttpInfo<ListFetchResponse>>

getByName

Parameters

Returns Promise<ListFetchResponse>

getByNameWithHttpInfo

Parameters

Returns Promise<HttpInfo<ListFetchResponse>>

remove

Parameters

Returns Promise<void>

removeWithHttpInfo

Parameters

Returns Promise<HttpInfo<void>>

restore

Parameters

Returns Promise<void>

restoreWithHttpInfo

Parameters

Returns Promise<HttpInfo<void>>

updateListFilters

Parameters

Returns Promise<ListUpdateResponse>

updateListFiltersWithHttpInfo

Parameters

Returns Promise<HttpInfo<ListUpdateResponse>>

updateName

Parameters

Returns Promise<ListUpdateResponse>

updateNameWithHttpInfo

Parameters

Returns Promise<HttpInfo<ListUpdateResponse>>

Settings

On This Page