SaaSFlow
DevelopersAPIReferencereports

Update report

Rename a report. Only the display title changes; the document and its numbers are untouched. A report that is still generating cannot be renamed and…

Authentication

Checking whether you're signed in…
PATCH
/companies/{companyId}/reports/{id}

Authorization

headerAuthorization<token>

A SaaSFlow API key (format sf_…) or an OAuth bearer token. Paste only the key — the proxy adds the Bearer prefix. Create an API key in Settings → Company settings → API keys — see API keys.

Path Parameters

companyId*string
Length1 <= length
id*string
Length1 <= length

Request Body

application/json
  1. body
title*string

The new display title of the report.

Length1 <= length <= 200

Response Body

Report renamed

application/json
  1. response
ok*boolean
curl -X PATCH 'https://api.saasflow.com/companies/string/reports/string' \  -H 'Content-Type: application/json' \  -d '{  "title": "string"}'
{  "ok": true}

Retrieve report

Retrieve one report, including its rendered document once generation has finished. Poll this after starting a report: until it is ready the document is…

Delete report

Delete a report and its superseded versions. A report that is still generating returns 409; wait for the run to finish before removing it.