Report Scheduling

Update a Report Schedule

Updates an existing report schedule configuration.

It requires the reportSchedules:Update permission in the API key.

Only active report schedules can be updated. If the schedule is already deleted or archived, the request will result in an error.

patch/reportSchedules/{reportScheduleKey}

Request

Path parameters

reportScheduleKeystring required

Uniquely identifies a report schedule object

Example:rsk-1e1dAHhgstYTUhlphPzZ

Request body

OR
OR
OR
OR
OR
OR
OR
OR

Example request

{
  "distributions": [
    "dst-1e1dAHhgstYTUhlphPzZ"
  ]
}

Response

The report schedule updated

OR
OR
OR
OR
OR
OR
OR
OR

Example response

{
  "key": "rsk-1e1dAHhgstYTUhlphPzZ",
  "agentKey": "cgt-1UF2NafdfrdPMf2XrS2",
  "distributions": [
    "dst-1e1dAHhgstYTUhlphPzZ"
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.