Skip to content
Start here

Cancel

Cancel a bulk action job
email_security.investigate.bulk.cancel.create(strjob_id, CancelCreateParams**kwargs) -> CancelCreateResponse
POST/accounts/{account_id}/email-security/investigate/bulk/{job_id}/cancel
ModelsExpand Collapse
class CancelCreateResponse:
action_params: ActionParams
One of the following:
class ActionParamsMove:
destination: Literal["Inbox", "JunkEmail", "DeletedItems", 2 more]
One of the following:
"Inbox"
"JunkEmail"
"DeletedItems"
"RecoverableItemsDeletions"
"RecoverableItemsPurges"
type: Literal["MOVE"]
expected_disposition: Optional[Literal["MALICIOUS", "MALICIOUS-BEC", "SUSPICIOUS", 7 more]]
One of the following:
"MALICIOUS"
"MALICIOUS-BEC"
"SUSPICIOUS"
"SPOOF"
"SPAM"
"BULK"
"ENCRYPTED"
"EXTERNAL"
"UNKNOWN"
"NONE"
class ActionParamsRelease:
type: Literal["RELEASE"]
action_type: Literal["MOVE", "RELEASE"]
One of the following:
"MOVE"
"RELEASE"
created_at: datetime
formatdate-time
job_id: str
formatuuid
messages_failed: int
messages_pending: int
messages_successful: int
search_params: SearchParams
Deprecatedaction_log: Optional[bool]

Deprecated, use GET /investigate/{investigate_id}/action_log instead. End of life: November 1, 2026.

alert_id: Optional[str]
delivery_status: Optional[Literal["delivered", "moved", "quarantined", 4 more]]

Delivery status of the message.

One of the following:
"delivered"
"moved"
"quarantined"
"rejected"
"deferred"
"bounced"
"queued"
detections_only: Optional[bool]
domain: Optional[str]
end: Optional[datetime]

End of search date range

formatdate-time
exact_subject: Optional[str]
final_disposition: Optional[Literal["MALICIOUS", "MALICIOUS-BEC", "SUSPICIOUS", 7 more]]
One of the following:
"MALICIOUS"
"MALICIOUS-BEC"
"SUSPICIOUS"
"SPOOF"
"SPAM"
"BULK"
"ENCRYPTED"
"EXTERNAL"
"UNKNOWN"
"NONE"
message_action: Optional[Literal["PREVIEW", "QUARANTINE_RELEASED", "MOVED"]]
One of the following:
"PREVIEW"
"QUARANTINE_RELEASED"
"MOVED"
message_id: Optional[str]
metric: Optional[str]
query: Optional[str]
recipient: Optional[str]
sender: Optional[str]
start: Optional[datetime]

Beginning of search date range

formatdate-time
subject: Optional[str]
submissions: Optional[bool]
status: Literal["PENDING", "DISCOVERING", "PROCESSING", 4 more]
One of the following:
"PENDING"
"DISCOVERING"
"PROCESSING"
"COMPLETED"
"FAILED"
"CANCELLED"
"SKIPPED"
total_messages_discovered: int
comment: Optional[str]
completed_at: Optional[datetime]
formatdate-time
started_at: Optional[datetime]
formatdate-time
status_message: Optional[str]