API Reference

Schedule reports -- Update

patch
https://dialpad.com/api/v2/schedulereports/

Updates a schedule report subscription by id. A schedule report is a mechanism to schedule daily, weekly or monthly record and statistics reports.

Added on Jul 6, 2022 for API v2

Rate limit: 1200 per minute.

Path Params
int64
required

The schedule reports subscription's ID.

Body Params
int64
required

Hour of the day when the report will execute considering the frequency and timezones between 0 and 23 e.g. 10 will be 10:00 am.

boolean | null
Defaults to false

Whether the statistics should be for trainees of the coach group with the given target_id.

boolean | null
Defaults to true

Whether or not this schedule reports event subscription is enabled.

int64
required

The logging endpoint's ID, which is generated after creating a webhook or websocket successfully.

string
enum
required

How often the report will execute.

Allowed:
string
required

[single-line only]

The name of the schedule reports.

int64
required

The day of the week or month when the report will execute considering the frequency. daily=0, weekly=0-6, monthly=0-30.

string
enum
required

The type of report that will be generated.

Allowed:
int64 | null

The target's id.

string | null
enum

Target's type.

string | null

Timezone using a tz database name.

Response

Updated 2 months ago

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 2 months ago