Update a report template

PATCH

/api/v1/reports/templates/{template_id}

• Production
• Local development

Update allowed fields on a report template. Rejects attempts to change tenant_id, id, or created_by_user_id.

Authorizations

• ApiKeyAuth

Parameters

Path Parameters

template_id

required

string

Request Body ^required

Schema for updating an existing report template.

All fields are optional; only provided fields are updated.

object

delivery_email

Any of:

string

string

null

null

description

Any of:

string

string

null

null

filters

Any of:

object

object

key

additional properties

any

null

null

groupings

Any of:

Array<string>

Array<string>

null

null

metric_ids

Any of:

Array<string>

Array<string>

null

null

name

Any of:

string

string

<= 120 characters

null

null

output_format

Any of:

string

string

null

null

schedule

Any of:

string

string

null

null

shared_with_tenant

Any of:

boolean

boolean

null

null

Responses

200

Successful Response

object

key

additional properties

any

422

Validation Error

object

detail

Array<object>

object

ctx

object

input

loc

required

Array

msg

required

string

type

required

string