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 returns 409.

Authentication

You're not signed in. Either sign in at app.saasflow.com and reload (then pick sessionCookie), or paste a SaaSFlow sf_… API key in the bearerAuth field below.
PATCH
/companies/{companyId}/reports/{id}

Authorization

Authorization<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.

In: header

Path Parameters

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

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

curl -X PATCH "https://example.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 absent and only the status tells you where it is. Returns 404 if the report does not exist or belongs to another company.

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.