ROroarkhq
Live Report

Update a live report

Changed on

Changes the fields sent. Set status to PAUSED to stop scheduled reports.

patch/v1/live-report/{reportId}

Request

  • Base URL
    https://api.roark.ai
  • URL
    https://api.roark.ai/v1/live-report/{reportId}
  • Auth
    HTTP bearer

Path parameters

reportIdstring uuid required

The live report ID

Request body

namestring
descriptionstring nullable
agentIdstring uuid nullable
dashboardIdstring uuid nullable
cadence'DAILY' | 'WEEKLY' | 'MONTHLY'
timezonestring
deliveryHourinteger
status'ACTIVE' | 'PAUSED'
includeTranscriptExcerptsboolean

Example request

{
  "status": "PAUSED"
}

Response

The report

Changes