OptionalrequestFactory: MembershipsApiRequestFactoryOptionalresponseProcessor: MembershipsApiResponseProcessorThe ILS ID of the `MANUAL` or `SNAPSHOT` list.
The IDs of the records to add to the list.
Optional_options: PromiseConfigurationOptionsAdd all of the records from a source list (specified by the sourceListId) to a destination list (specified by the listId). Records that are already members of the destination list will be ignored. The destination and source list IDs must be different. The destination and source lists must contain records of the same type (e.g. contacts, companies, etc.). This endpoint only works for destination lists that have a processingType of MANUAL or SNAPSHOT. The source list can have any processingType. This endpoint only supports a sourceListId for lists with less than 100,000 memberships.
Add All Records from a Source List to a Destination List
The ILS ID of the `MANUAL` or `SNAPSHOT` destination list, which the source list records are added to.
The ILS ID of the source list to grab the records from, which are then added to the destination list.
Optional_options: PromiseConfigurationOptionsAdd all of the records from a source list (specified by the sourceListId) to a destination list (specified by the listId). Records that are already members of the destination list will be ignored. The destination and source list IDs must be different. The destination and source lists must contain records of the same type (e.g. contacts, companies, etc.). This endpoint only works for destination lists that have a processingType of MANUAL or SNAPSHOT. The source list can have any processingType. This endpoint only supports a sourceListId for lists with less than 100,000 memberships.
Add All Records from a Source List to a Destination List
The ILS ID of the `MANUAL` or `SNAPSHOT` destination list, which the source list records are added to.
The ILS ID of the source list to grab the records from, which are then added to the destination list.
Optional_options: PromiseConfigurationOptionsAdd and/or remove records that have already been created in the system to and/or from a list. This endpoint only works for lists that have a processingType of MANUAL or SNAPSHOT.
Add and/or Remove Records from a List
The ILS ID of the `MANUAL` or `SNAPSHOT` list.
The IDs of the records to add and/or remove from the list.
Optional_options: PromiseConfigurationOptionsAdd and/or remove records that have already been created in the system to and/or from a list. This endpoint only works for lists that have a processingType of MANUAL or SNAPSHOT.
Add and/or Remove Records from a List
The ILS ID of the `MANUAL` or `SNAPSHOT` list.
The IDs of the records to add and/or remove from the list.
Optional_options: PromiseConfigurationOptionsAdd the records provided to the list. Records that do not exist or that are already members of the list are ignored. This endpoint only works for lists that have a processingType of MANUAL or SNAPSHOT.
Add Records to a List
The ILS ID of the `MANUAL` or `SNAPSHOT` list.
The IDs of the records to add to the list.
Optional_options: PromiseConfigurationOptionsFor given record provide lists this record is member of. Get lists record is member of
Object type id of the record
Id of the record
Optional_options: PromiseConfigurationOptionsFor given record provide lists this record is member of. Get lists record is member of
Object type id of the record
Id of the record
Optional_options: PromiseConfigurationOptionsFetch the memberships of a list in order sorted by the recordId of the records in the list. The recordIds are sorted in ascending order if an after offset or no offset is provided. If only a before offset is provided, then the records are sorted in descending order. The after offset parameter will take precedence over the before offset in a case where both are provided.
Fetch List Memberships Ordered by ID
The ILS ID of the list.
Optionalafter: stringThe paging offset token for the page that comes `after` the previously requested records. If provided, then the records in the response will be the records following the offset, sorted in ascending order. Takes precedence over the `before` offset.
Optionalbefore: stringThe paging offset token for the page that comes `before` the previously requested records. If provided, then the records in the response will be the records preceding the offset, sorted in descending order.
Optionallimit: numberThe number of records to return in the response. The maximum `limit` is 250.
Optional_options: PromiseConfigurationOptionsFetch the memberships of a list in order sorted by the time the records were added to the list. The recordIds are sorted in ascending order if an after offset or no offset is provided. If only a before offset is provided, then the records are sorted in descending order. The after offset parameter will take precedence over the before offset in a case where both are provided.
Fetch List Memberships Ordered by Added to List Date
The ILS ID of the list.
Optionalafter: stringThe paging offset token for the page that comes `after` the previously requested records. If provided, then the records in the response will be the records following the offset, sorted in ascending order. Takes precedence over the `before` offset.
Optionalbefore: stringThe paging offset token for the page that comes `before` the previously requested records. If provided, then the records in the response will be the records preceding the offset, sorted in descending order.
Optionallimit: numberThe number of records to return in the response. The maximum `limit` is 250.
Optional_options: PromiseConfigurationOptionsFetch the memberships of a list in order sorted by the time the records were added to the list. The recordIds are sorted in ascending order if an after offset or no offset is provided. If only a before offset is provided, then the records are sorted in descending order. The after offset parameter will take precedence over the before offset in a case where both are provided.
Fetch List Memberships Ordered by Added to List Date
The ILS ID of the list.
Optionalafter: stringThe paging offset token for the page that comes `after` the previously requested records. If provided, then the records in the response will be the records following the offset, sorted in ascending order. Takes precedence over the `before` offset.
Optionalbefore: stringThe paging offset token for the page that comes `before` the previously requested records. If provided, then the records in the response will be the records preceding the offset, sorted in descending order.
Optionallimit: numberThe number of records to return in the response. The maximum `limit` is 250.
Optional_options: PromiseConfigurationOptionsFetch the memberships of a list in order sorted by the recordId of the records in the list. The recordIds are sorted in ascending order if an after offset or no offset is provided. If only a before offset is provided, then the records are sorted in descending order. The after offset parameter will take precedence over the before offset in a case where both are provided.
Fetch List Memberships Ordered by ID
The ILS ID of the list.
Optionalafter: stringThe paging offset token for the page that comes `after` the previously requested records. If provided, then the records in the response will be the records following the offset, sorted in ascending order. Takes precedence over the `before` offset.
Optionalbefore: stringThe paging offset token for the page that comes `before` the previously requested records. If provided, then the records in the response will be the records preceding the offset, sorted in descending order.
Optionallimit: numberThe number of records to return in the response. The maximum `limit` is 250.
Optional_options: PromiseConfigurationOptionsRemove the records provided from the list. Records that do not exist or that are not members of the list are ignored. This endpoint only works for lists that have a processingType of MANUAL or SNAPSHOT.
Remove Records from a List
The ILS ID of the `MANUAL` or `SNAPSHOT` list.
The IDs of the records to remove from the list.
Optional_options: PromiseConfigurationOptionsRemove all of the records from a list. Note: The list is not deleted. This endpoint only works for lists that have a processingType of MANUAL or SNAPSHOT. This endpoint only supports lists that have less than 100,000 memberships.
Delete All Records from a List
The ILS ID of the `MANUAL` or `SNAPSHOT` list.
Optional_options: PromiseConfigurationOptionsRemove all of the records from a list. Note: The list is not deleted. This endpoint only works for lists that have a processingType of MANUAL or SNAPSHOT. This endpoint only supports lists that have less than 100,000 memberships.
Delete All Records from a List
The ILS ID of the `MANUAL` or `SNAPSHOT` list.
Optional_options: PromiseConfigurationOptionsRemove the records provided from the list. Records that do not exist or that are not members of the list are ignored. This endpoint only works for lists that have a processingType of MANUAL or SNAPSHOT.
Remove Records from a List
The ILS ID of the `MANUAL` or `SNAPSHOT` list.
The IDs of the records to remove from the list.
Optional_options: PromiseConfigurationOptions
Add the records provided to the list. Records that do not exist or that are already members of the list are ignored. This endpoint only works for lists that have a
processingTypeofMANUALorSNAPSHOT. Add Records to a List