Sign in

v1

latestOpenAPI 3.0.02026-08-062903562.2 MB
Annual Summary
Organization

Update ASR Batch Schedule and/or Audience

Update the scheduled delivery time and/or audience filters for an ASR batch. Both parameters are optional - you can update schedule only, audience only, or both together. The batch must be in 'scheduled' or 'pending' status. Changes are synced to the legacy MongoDB Message for compatibility.

put/organizations/{organization_id}/annual-summary-reports/{year}/schedule

Path parameters

organization_idinteger required
Example:1

The specified Organization ID

yearinteger required
Example:2024

The report year

Request body

scheduled_atstring date-time

When to execute the batch (optional, must be in the future)

Example request

{
  "scheduled_at": "2024-12-31T23:59:59Z",
  "audience": {
    "offline": true,
    "one_time": true,
    "recurring": true
  }
}

Response

Batch updated successfully

organization_idinteger
report_yearinteger
statusstring
scheduled_atstring nullable
messagestring

Example response

{
  "organization_id": 1,
  "report_year": 2024,
  "status": "scheduled",
  "scheduled_at": "2024-12-31T23:59:59+00:00",
  "audience": {
    "offline": true,
    "one_time": true,
    "recurring": true
  },
  "message": "Batch updated successfully."
}