Skip to main content
PATCH
Update report

Authorizations

Authorization
string
header
required

Use your API key as a Bearer token. API keys can be generated in Settings → Integrations → API Access.

Path Parameters

id
string<uuid>
required

Report ID

Body

application/json
title
string

Report title

Required string length: 1 - 500
description
string | null

Report description (null to clear)

Maximum string length: 2000
companyId
string<uuid> | null

Company ID (null to clear)

reportTypeId
string<uuid> | null

Report type ID (null to clear)

dateStart
string | null

Report date range start (null to clear)

dateEnd
string | null

Report date range end (null to clear)

reportStructure
object

Report content structure

status
enum<string>

Report status

Available options:
draft,
published
isShared
boolean

Whether report is shared

Response

Report updated successfully

data
object
required