Skip to main content

tools.ozone.moderation.scheduleAction

#main

Schedule a moderation action to be executed at a future time

Input

  • Encoding: application/json
PropertyTypeKnown ValuesRequiredDescription
actionunion of
#takedown
--
subjectsarray of string-Array of DID subjects to schedule the action for
createdBystring (did)--
scheduling#schedulingConfig--
modTooltools.ozone.moderation.defs#modTool--

Output

  • Encoding: application/json
PropertyTypeKnown ValuesRequiredDescription
ref#scheduledActionResults--

#takedown

Schedule a takedown action

PropertyTypeKnown ValuesRequiredDescription
commentstring--
durationInHoursinteger-Indicates how long the takedown should be in effect before automatically expiring.
acknowledgeAccountSubjectsboolean-If true, all other reports on content authored by this account will be resolved (acknowledged).
policiesarray of string-Names/Keywords of the policies that drove the decision.
severityLevelstring-Severity level of the violation (e.g., 'sev-0', 'sev-1', 'sev-2', etc.).
strikeCountinteger-Number of strikes to assign to the user when takedown is applied.
strikeExpiresAtstring (datetime)-When the strike should expire. If not provided, the strike never expires.
emailContentstring-Email content to be sent to the user upon takedown.
emailSubjectstring-Subject of the email to be sent to the user upon takedown.

#schedulingConfig

Configuration for when the action should be executed

PropertyTypeKnown ValuesRequiredDescription
executeAtstring (datetime)-Exact time to execute the action
executeAfterstring (datetime)-Earliest time to execute the action (for randomized scheduling)
executeUntilstring (datetime)-Latest time to execute the action (for randomized scheduling)

#scheduledActionResults

PropertyTypeKnown ValuesRequiredDescription
succeededarray of string--
failedarray of #failedScheduling--

#failedScheduling

PropertyTypeKnown ValuesRequiredDescription
subjectstring (did)--
errorstring--
errorCodestring--