PATCH /scheduled-jobs/{job_id}

Update a Scheduled Job by ID

Servers

Path parameters

Name Type Required Description
job_id Integer Yes

The ID of the Scheduled Job you'd like to update

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
campaign_ids[] Array No

A list of campaign_ids that should be considered during the job

frequency String No

Valid values:

  • "weekly"
  • "daily"
project_id Integer No

The project that the job is associated with

archived Boolean No

Whether the Scheduled Job is archived

experiment_ids[] Array No

A list of experiment_ids that should be considered during the job

job_type String No

The type of job to be performed

Valid values:

  • "project_results"
output_channels Object No

An object describing how the output of the job should be communicated

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.