> ## Documentation Index > Fetch the complete documentation index at: https://api-docs.hellotracks.com/llms.txt > Use this file to discover all available pages before exploring further. # Update a recurring report > Changes the fields sent. An unknown, foreign or deleted id is answered with 400 invalid_request. This is the older reporting API; for new work use the newer routes (GET /reports/catalog, POST /reports/preview, POST /reports/run, /reports/saved). Admins, operators and the company key may call it; workers get 403 permission_denied. ## OpenAPI ````yaml v1/openapi.json PATCH /reports/recurring/{id} openapi: 3.1.0 info: title: Hellotracks REST API version: '1' description: >- Plain REST resources over HTTPS, for tools, automations and services. The ht command line is built on it. contact: email: api@hellotracks.com servers: - url: https://api.hellotracks.com/v1 security: - ApiKey: [] tags: - name: Sign-up and sign-in description: >- Create a company or get an API key by an emailed code, without a key; and check which account a key belongs to. - name: Company description: The company the API key belongs to, with its settings and teams. - name: Members description: 'The people in the company: admins, operators and workers.' - name: API keys description: 'The company''s API keys: list, create, revoke and delete.' - name: Jobs description: 'Jobs: work at a location on a date, assigned to a member.' - name: Places description: 'Places: customer sites and other saved locations with a check-in radius.' - name: Zones description: 'Zones: the company''s geofences.' - name: Routing description: Route optimization for one member's day. - name: ETA pages description: >- Live ETA pages (eta.page links) that show a job's recipient when the worker arrives. - name: Maps description: Rendered maps as GeoJSON, and public map share links. - name: Timesheets description: Clock-in and clock-out entries of members, with totals, and editing them. - name: Forms description: >- Form templates, submitted forms, attachments for file and image fields, and forms linked to places and jobs. - name: Alerts description: >- Alert rules (configs) that watch members, places and zones, and the alerts (instances) they raised. - name: Reports description: >- Reports: the newer reporting API (catalog, preview, run, saved) and the older one (types, generate, jobs, uploads, recurring). - name: Webhooks description: URLs Hellotracks calls when jobs, check-ins, clock-ins or alerts happen. paths: /reports/recurring/{id}: patch: tags: - Reports summary: Update a recurring report description: >- Changes the fields sent. An unknown, foreign or deleted id is answered with 400 invalid_request. This is the older reporting API; for new work use the newer routes (GET /reports/catalog, POST /reports/preview, POST /reports/run, /reports/saved). Admins, operators and the company key may call it; workers get 403 permission_denied. operationId: updateRecurringReport parameters: - name: id in: path required: true description: Recurring report id. schema: type: string example: 6560000000000000000000c1 requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/RecurringReportInput' example: status: paused responses: '200': description: OK content: application/json: schema: allOf: - $ref: '#/components/schemas/Envelope' properties: data: type: object properties: recurringReport: $ref: '#/components/schemas/RecurringReport' items: type: array items: $ref: '#/components/schemas/RecurringReport' description: >- All recurring reports of the company (not deleted), after the change. example: data: recurringReport: id: 6560000000000000000000c1 name: Weekly jobs type: jobs frame: week weekdays: 1 weekdayNames: - monday memberIds: - a1b2c3 placeIds: [] notifyMemberIds: - a1b2c3 format: xlsx status: 1 statusText: paused startDay: 20261102 startDate: '2026-11-02' savedAt: 1762070000000 creatorUid: a1b2c3 createdAt: 1762070000000 createdBy: a1b2c3 columns: - key: title - key: status label: State options: {} items: - id: 6560000000000000000000c1 name: Weekly jobs type: jobs frame: week weekdays: 1 weekdayNames: - monday memberIds: - a1b2c3 placeIds: [] notifyMemberIds: - a1b2c3 format: xlsx status: 1 statusText: paused startDay: 20261102 startDate: '2026-11-02' savedAt: 1762070000000 creatorUid: a1b2c3 createdAt: 1762070000000 createdBy: a1b2c3 columns: - key: title - key: status label: State options: {} error: null meta: path: /v1/reports/recurring/6560000000000000000000c1 method: PATCH '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/ServerError' components: schemas: RecurringReportInput: type: object additionalProperties: false description: >- On create, name and type are required. On update, fields left out keep their values. properties: name: type: string type: type: string enum: - jobs - dayroute - places - alerts - checkins - timesheet - members - mileage - placeonsite - memberonsite - stopsreport - gpx - activities - timeline - worksheet - timeallocation - statistics description: A type with supportsRecurring (all but formsubmissions). memberIds: type: array items: type: string placeIds: type: array items: type: string notifyMemberIds: type: array items: type: string description: Members who get the report by e-mail. frame: type: string enum: - day - week - twoweeks default: week weekdays: oneOf: - type: integer minimum: 0 maximum: 127 - type: array items: type: string description: >- Bitmask number (not a numeric string) or weekday names; default 1 (Monday). format: type: string status: oneOf: - type: string enum: - active - paused - deleted - type: integer enum: - 0 - 1 - 2 description: Lower case only; default active. startDate: type: string format: date description: YYYY-MM-DD; defaults to today. startDay: type: integer minimum: 19000101 maximum: 29991231 description: YYYYMMDD; startDate wins. columns: type: array items: $ref: '#/components/schemas/ReportColumnPick' options: type: object additionalProperties: type: string Envelope: type: object properties: data: description: The payload. error: type: 'null' meta: $ref: '#/components/schemas/Meta' RecurringReport: type: object properties: id: type: string name: type: string type: type: string enum: - jobs - dayroute - places - alerts - checkins - timesheet - members - mileage - placeonsite - memberonsite - stopsreport - gpx - activities - timeline - worksheet - timeallocation - statistics - formsubmissions frame: type: string enum: - day - week - twoweeks weekdays: type: integer description: Bitmask, bit 0 = Monday ... bit 6 = Sunday. weekdayNames: type: array items: type: string enum: - monday - tuesday - wednesday - thursday - friday - saturday - sunday memberIds: type: array items: type: string placeIds: type: array items: type: string notifyMemberIds: type: array items: type: string format: type: string status: type: integer enum: - 0 - 1 - 2 statusText: type: string enum: - active - paused - deleted - unknown startDay: type: integer description: YYYYMMDD. startDate: type: string format: date description: Only when startDay is set. savedAt: type: integer format: int64 description: Milliseconds since the epoch. creatorUid: type: string createdAt: type: integer format: int64 description: Milliseconds since the epoch. createdBy: type: string columns: type: array items: type: object properties: key: type: string label: type: string options: type: object additionalProperties: type: string ReportColumnPick: type: object additionalProperties: false required: - key properties: key: type: string description: A column key of the report type. label: type: string description: Column title in the file. rename: type: string description: Alias of label. Meta: type: object properties: path: type: string description: The request path, without /v1. example: /jobs method: type: string example: GET ErrorEnvelope: type: object properties: data: type: 'null' error: $ref: '#/components/schemas/Error' meta: $ref: '#/components/schemas/Meta' Error: type: object required: - code - message properties: code: type: string description: Stable error code for programs. enum: - invalid_request - invalid_format - invalid_data - invalid_api_key - unknown_user - authentication_failed - forbidden - not_found - already_exists - throttled - not_ready - clock_invalid - force_logout - internal_error - unknown_error message: type: string description: Why it failed, for people. responses: BadRequest: description: The request is invalid. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' example: data: null error: code: invalid_request message: date must be YYYY-MM-DD meta: path: /jobs method: GET Unauthorized: description: The API key is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' example: data: null error: code: invalid_api_key message: Invalid Hellotracks API key. meta: path: /jobs method: GET Forbidden: description: The key may not do this. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' example: data: null error: code: forbidden message: No permission. meta: path: /jobs method: GET TooManyRequests: description: Too many requests; slow down. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' example: data: null error: code: throttled message: Too many requests. meta: path: /jobs method: GET ServerError: description: Hellotracks failed; retry later. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' example: data: null error: code: internal_error message: Hellotracks API is temporarily unavailable. meta: path: /jobs method: GET securitySchemes: ApiKey: type: apiKey in: header name: API-Key description: >- Your API key, from More → API & Integrations in the dashboard, or from ht signup / ht auth login. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.