Skip to Content
SaaSFlow
DevelopersAPIReferenceproduct_groups

Update product group

Rename a product group or archive it. Archiving hides the group without changing the products assigned to it.

Authentication

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

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
productGroupId*string
Formatuuid

Request Body

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

Response Body

Updated 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 PUT 'https://api.saasflow.com/companies/497f6eca-6276-4993-bfeb-53cbbbba6f08/product_groups/497f6eca-6276-4993-bfeb-53cbbbba6f08' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "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"}