OptionalrequestFactory: ListsApiRequestFactoryOptionalresponseProcessor: ListsApiResponseProcessorThe ID of the list that you want to cancel the conversion for.
Optional_options: PromiseConfigurationOptionsDelete an existing scheduled conversion for a list. Cancel the conversion of a list
The ID of the list that you want to cancel the conversion for.
Optional_options: PromiseConfigurationOptionsCreate a new list with the provided object list definition. Create List
Optional_options: PromiseConfigurationOptionsCreate a new list with the provided object list definition. Create List
Optional_options: PromiseConfigurationOptionsSearch lists by list name or page through all lists by providing an empty query value.
Search Lists
The IDs of the records to add and/or remove from the list.
Optional_options: PromiseConfigurationOptionsSearch lists by list name or page through all lists by providing an empty query value.
Search Lists
The IDs of the records to add and/or remove from the list.
Optional_options: PromiseConfigurationOptionsFetch 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
OptionallistIds: string[]The ILS IDs of the lists to fetch.
OptionalincludeFilters: booleanA 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: PromiseConfigurationOptionsFetch 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
OptionallistIds: string[]The ILS IDs of the lists to fetch.
OptionalincludeFilters: booleanA 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: PromiseConfigurationOptionsFetch a single list by ILS list ID. Fetch List by ID
The ILS ID of the list to fetch.
OptionalincludeFilters: booleanA 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: PromiseConfigurationOptionsFetch a single list by ILS list ID. Fetch List by ID
The ILS ID of the list to fetch.
OptionalincludeFilters: booleanA 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: PromiseConfigurationOptionsFetch a single list by list name and object type. Fetch List by Name
The name of the list to fetch. This is not case sensitive.
The object type ID of the object types stored by the list to fetch. For example, `0-1` for a `CONTACT` list.
OptionalincludeFilters: booleanA 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: PromiseConfigurationOptionsFetch a single list by list name and object type. Fetch List by Name
The name of the list to fetch. This is not case sensitive.
The object type ID of the object types stored by the list to fetch. For example, `0-1` for a `CONTACT` list.
OptionalincludeFilters: booleanA 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: PromiseConfigurationOptionsRetrieve the conversion details for a list. This can be used to check for an upcoming conversion, or to get the details of when a list was already converted. Retrieve the conversion details for a list
The ID of the list to schedule the conversion for.
Optional_options: PromiseConfigurationOptionsRetrieve the conversion details for a list. This can be used to check for an upcoming conversion, or to get the details of when a list was already converted. Retrieve the conversion details for a list
The ID of the list to schedule the conversion for.
Optional_options: PromiseConfigurationOptionsDelete 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
The ILS ID of the list to delete.
Optional_options: PromiseConfigurationOptionsDelete 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
The ILS ID of the list to delete.
Optional_options: PromiseConfigurationOptionsRestore 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
The ILS ID of the list to restore.
Optional_options: PromiseConfigurationOptionsRestore 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
The ILS ID of the list to restore.
Optional_options: PromiseConfigurationOptionsSchedule the conversion of an active list into a static list, or update the already scheduled conversion. This can be scheduled for a specific date or based on activity. Schedule or update the conversion of a list to static
The ID of the list to schedule the conversion for.
Optional_options: PromiseConfigurationOptionsSchedule the conversion of an active list into a static list, or update the already scheduled conversion. This can be scheduled for a specific date or based on activity. Schedule or update the conversion of a list to static
The ID of the list to schedule the conversion for.
Optional_options: PromiseConfigurationOptionsUpdate 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
The ILS ID of the list to update.
OptionalenrollObjectsInWorkflows: booleanA 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: PromiseConfigurationOptionsUpdate 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
The ILS ID of the list to update.
OptionalenrollObjectsInWorkflows: booleanA 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: PromiseConfigurationOptionsUpdate the name of a list. The name must be globally unique relative to all other public lists in the portal. Update List Name
The ILS ID of the list to update.
OptionallistName: stringThe name to update the list to.
OptionalincludeFilters: booleanA 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: PromiseConfigurationOptionsUpdate the name of a list. The name must be globally unique relative to all other public lists in the portal. Update List Name
The ILS ID of the list to update.
OptionallistName: stringThe name to update the list to.
OptionalincludeFilters: booleanA 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: PromiseConfigurationOptions
Delete an existing scheduled conversion for a list. Cancel the conversion of a list