Skip to main content
PATCH
Change a report

Authorizations

Authorization
string
header
required

An API key, sent as Authorization: Bearer stfy_live_…. See Authentication for how to get one and which scopes it needs.

Path Parameters

report_id
string
required

The report's id, from GET /v1/reports

Body

application/json
description
string | null

null clears it

Maximum string length: 2000
name
string

Unique across the workspace

Required string length: 1 - 255
owner
string | null

An email, as on create; null leaves a team report with no owner

Required string length: 3 - 320
Pattern: ^[^@\s]+@[^@\s]+$
visibility
enum<string>
Available options:
team,
private

Response

200 - application/json

Successful Response

created_at
string<date-time>
required
description
string | null
required
id
string
required
name
string
required

Unique across the workspace

owner
string | null
required

The owner's email: besides admins, only the owner can change it in the app. Null when it has no owner, or its owner is no longer a user

updated_at
string<date-time>
required
visibility
enum<string>
required

team (Public in the app: everyone in the workspace sees it on the reports page) or private (only its owner sees it there; admins can change it but don't see it listed). The API lists both

Available options:
team,
private
widgets
ReportWidget · object[]
required