Skip to Content
SaaSFlow
DevelopersAPIReferenceproduct_groups

Create product group

Create a product group. order is required and sets the position in the list; pass a number higher than every existing group to append at the end.

Authentication

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

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
Formatuuid

Request Body

application/json
  1. body
name*string
Length1 <= length
archived?boolean
Defaultfalse
order*number

Response Body

Created product group

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

The name of the product group.

archived*boolean

Flag indicating if the product group is archived.

order*number

A number used for ordering product groups in the UI.

Range-8388608 <= value <= 8388607
createdTime*|
Formatdate-time
createdUserId*string|null
lastUpdatedTime*|
Formatdate-time
lastUpdatedUserId*string|null
Example Request
curl -X POST 'https://api.saasflow.com/companies/497f6eca-6276-4993-bfeb-53cbbbba6f08/product_groups' \  -H 'Content-Type: application/json' \  -d '{  "name": "string",  "order": 0}'
Example Response201
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "companyId": "8bb73d03-06b4-47c7-80c7-59301f770eda",  "name": "string",  "archived": true,  "order": -8388608,  "createdTime": "2019-08-24T14:15:22Z",  "createdUserId": "string",  "lastUpdatedTime": "2019-08-24T14:15:22Z",  "lastUpdatedUserId": "string"}