Skip to main content
PATCH
Update a recurring report

Authorizations

API-Key
string
header
required

Your API key, from More → API & Integrations in the dashboard, or from ht signup / ht auth login.

Path Parameters

id
string
required

Recurring report id.

Body

application/json

On create, name and type are required. On update, fields left out keep their values.

name
string
type
enum<string>

A type with supportsRecurring (all but formsubmissions).

Available options:
jobs,
dayroute,
places,
alerts,
checkins,
timesheet,
members,
mileage,
placeonsite,
memberonsite,
stopsreport,
gpx,
activities,
timeline,
worksheet,
timeallocation,
statistics
memberIds
string[]
placeIds
string[]
notifyMemberIds
string[]

Members who get the report by e-mail.

frame
enum<string>
default:week
Available options:
day,
week,
twoweeks
weekdays

Bitmask number (not a numeric string) or weekday names; default 1 (Monday).

Required range: 0 <= x <= 127
format
string
status

Lower case only; default active.

Available options:
active,
paused,
deleted
startDate
string<date>

YYYY-MM-DD; defaults to today.

startDay
integer

YYYYMMDD; startDate wins.

Required range: 19000101 <= x <= 29991231
columns
object[]
options
object

Response

OK

data
object

The payload.

error
null
meta
object