SaaSFlow
DevelopersAPIReferencecomments

Create comment

Post a comment on a transaction. `transactionId` is required and cannot be changed later. `taggedUserIds` records which teammates are mentioned, which is how the app renders @-mentions in the thread.

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.
POST
/companies/{companyId}/comments

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

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "https://example.com/companies/string/comments" \  -H "Content-Type: application/json" \  -d '{    "transactionId": "string",    "text": "string"  }'
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "companyId": "8bb73d03-06b4-47c7-80c7-59301f770eda",  "transactionId": "75906707-8c31-479c-b354-aa805c4cefbc",  "text": "string",  "taggedUserIds": [    "string"  ],  "likedUserIds": [    "string"  ],  "createdTime": "2019-08-24T14:15:22Z",  "createdUserId": "string",  "lastUpdatedTime": "2019-08-24T14:15:22Z",  "lastUpdatedUserId": "string"}

List comments

List comments. Comments are always attached to a transaction, which is how teams discuss what a payment was for. Pass `transactionId` to get the thread on one transaction; omit it to get every comment in the company.

Retrieve comment

Retrieve a single comment by id, including who is tagged in it and who liked it. Returns 404 if the comment does not exist or belongs to another company.