v4

latestOpenAPI 3.0.02026-08-04109113304.5 KB

Scheduled Jobs

Update a Scheduled Job

Update a Scheduled Job by ID

patch/scheduled-jobs/{job_id}

Path parameters

job_idinteger required

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

Request body

archivedboolean

Whether the Scheduled Job is archived

campaign_idsinteger[]

A list of campaign_ids that should be considered during the job

experiment_idsinteger[]

A list of experiment_ids that should be considered during the job

frequency'daily' | 'weekly'

job_type'project_results'

The type of job to be performed

output_channelsobject

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

project_idinteger

The project that the job is associated with

Response

Return the updated Scheduled Job

account_idinteger

The account that the job is associated with

archivedboolean

Whether the Scheduled Job is archived

campaign_idsinteger[]

A list of campaign_ids that should be considered during the job

experiment_idsinteger[]

A list of experiment_ids that should be considered during the job

frequency'daily' | 'weekly' required

How often the job should be performed

idinteger

The unique identifier of the Scheduled Job

job_type'project_results' required

The type of job to be performed

output_channelsobject

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

project_idinteger required

The project that the job is associated with

Example response

{
  "account_id": 456,
  "campaign_ids": [
    12,
    34
  ],
  "experiment_ids": [
    56,
    78,
    90
  ],
  "frequency": "weekly",
  "id": 123,
  "job_type": "project_results",
  "project_id": 789
}