Skip to main content
POST
/
api
/
groups
/
{group_id}
/
product_groups
Add a product to a group
curl --request POST \
  --url https://clarus-api.com/api/groups/{group_id}/product_groups \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Clarus-Subdomain: <api-key>' \
  --data '
{
  "data": {
    "type": "product_groups",
    "attributes": {
      "group_id": 456,
      "product_id": 123
    }
  }
}
'
{
  "data": {
    "id": 123,
    "type": "product_groups",
    "attributes": {
      "group_id": 123,
      "product_id": 123
    }
  }
}

​
Request Structure

{
  "data": {
    "type": "product_groups",
    "attributes": {
      "group_id": 456,
      "product_id": 123
    }
  }
}

​
Key Fields

FieldRequiredDescription
group_idYesID of the group (must match the path parameter)
product_idYesID of the product to add to the group

Authorizations

​
Authorization
string
header
required

OAuth 2.0 authentication. Use the client credentials or authorization code flow to obtain an access token.

​
X-Clarus-Subdomain
string
header
required

The subdomain/tenant name identifying which tenant's data to access. Required for all API requests.

Path Parameters

​
group_id
integer
required

The unique identifier of the group to add the product to

Body

application/json
​
data
object
required

Response

Product added to group successfully

​
data
object