BulkDelete Action

Submits a bulk delete job that deletes selected records in bulk. This job runs asynchronously in the background without blocking other activities.

Parameters

Parameters allow for data to be passed to the action.

Name Type Nullable Unicode Description
QuerySet
Collection( QueryExpression ) False True An array of queries for a bulk delete job
JobName
Edm.String False False The name of an asynchronous bulk delete job
SendEmailNotification
Edm.Boolean False True Indicates whether an email notification is sent after the bulk delete job has finished running
ToRecipients
Collection( activityparty ) False True An array of IDs for the system users (users) who are listed in the To box of an email notification.
CCRecipients
Collection( activityparty ) False True An array of IDs for the system users (users) who are listed in the Cc box of the email notification.
RecurrencePattern
Edm.String False False The recurrence pattern for the bulk delete job
StartDateTime
Edm.DateTimeOffset False True The start date and time to run a bulk delete job
SourceImportId
Edm.Guid True True The ID of the data import job
RunNow
Edm.Boolean True True For internal use only.

Return Type

Type Nullable Description
BulkDeleteResponse False The BulkDelete action returns the following value.

See also