Update a schedule
patch
https://api.flactrum.com/v1/report-schedules/{schedule}
| Required scope |
reports.write
|
| Success status | 200 |
| Returns |
One ReportSchedule object |
Parameters
| Name | In | Type | Description |
|---|
| schedule * |
path |
string |
ULID of the record. |
Request body
| Field | Type | Description |
|---|
| name * |
string |
— |
| category * |
string |
— |
| period_type * |
string |
— |
| branch_id |
string|null |
— |
| recipients * |
array |
At least one — a schedule with no recipients silently does nothing. |
| format |
string |
— |
| send_at * |
string |
— |
| days_of_week |
array |
— |
| is_active |
boolean |
— |
Response fields
| Field | Type | Description |
|---|
| id |
string |
— |
| name |
string |
— |
| category |
string |
— |
| period_type |
string |
— |
| branch_id |
string|null |
— |
| recipients |
array |
— |
| format |
string |
— |
| send_at |
string |
— |
| days_of_week |
array|null |
Empty means every day. 1 is Monday. |
| is_active |
boolean |
— |
| last_sent_at |
string|null |
— |
Examples