SaaSFlow
DevelopersAPIReferenceproducts

Create product

Create a product. Pass productGroupId to file it under a group straight away, or leave it null or absent for an ungrouped product.

Authentication

Checking whether you're signed in…
POST
/companies/{companyId}/products

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

Request Body

application/json
  1. body
name*string
Length1 <= length
productGroupId?string|null

Response Body

Created product

application/json
  1. response
id*string
Formatuuid
companyId*string
Formatuuid
name*string

The name of the product.

nameManuallyEdited*boolean

Whether the name is protected from integration updates after a manual rename.

productGroupId*|

The ID of the product group this product belongs to. Null if ungrouped.

Formatuuid
order*number

A number used for ordering products within their group in the UI.

Range-8388608 <= value <= 8388607
createdTime*|
Formatdate-time
createdUserId*string|null
lastUpdatedTime*|
Formatdate-time
lastUpdatedUserId*string|null
externalIds*array<string>

External IDs (URNs) linked to this product (e.g., Stripe, HubSpot).

curl -X POST "https://example.com/companies/string/products" \  -H "Content-Type: application/json" \  -d '{    "name": "string"  }'
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "companyId": "8bb73d03-06b4-47c7-80c7-59301f770eda",  "name": "string",  "nameManuallyEdited": true,  "productGroupId": "c416ccc2-c7d5-4733-9136-58a3b93937ed",  "order": -8388608,  "createdTime": "2019-08-24T14:15:22Z",  "createdUserId": "string",  "lastUpdatedTime": "2019-08-24T14:15:22Z",  "lastUpdatedUserId": "string",  "externalIds": [    "string"  ]}

List products

List a company's products, each with subscriptionCount (how many subscriptions have booked at least one event against it), activeSubscriptionCount (how…

Linked systems

The integrations at least one product is linked to, as the values the list endpoint accepts for linkedTo (e.g. ["digistore24", "stripe"]). Empty when no…