Home
API Reference

Create scheduled job

post
https://example.com/api/v3/schedules

Create a new scheduled job with tasks.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string

Optional: Description for the scheduledJob.

boolean

Optional: Enable or disable.

string

Optional: The instructions for the recipient.

string
enum
Defaults to UNDEFINED_TYPE

Audit Type decides whether it is an internal or external audit. Audit message is sent if a task has a recipient.

  • UNDEFINED_TYPE: if undefined, it will be treated as external
Allowed:
string

Name of the schedule.

string
enum
Defaults to UNDEFINED_NOTIFICATION
  • UNDEFINED_NOTIFICATION: if undefined, it will be treated as no notification
Allowed:
string
recipient
object

Recipient includes the receiver data for this job.

recipients
array of objects
Optional: The recipients of the notification when the entire job completes
retention
object

Retention include amount of retention time and whether to archive once over.

scheduler
object

Scheduler includes all fields used to schedule a report.

tags
array of strings

Optional: Tags to use.

tags
tasks
array of objects
Array of sequential jobs to run
Responses

Updated over 1 year ago

Language
Credentials
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated over 1 year ago