For the complete documentation index, see llms.txt. This page is also available as Markdown.

Update Product Group

Update the general fields (name, manual-sort flag, status).

Read the existing product group first. Check the replacement rules below before sending a partial list or localized value.

Behaviour

Only the fields you send are changed; omitted fields keep their stored value.

Connected products/companies and type are preserved.

Requires the productGroups:write scope.

put
Authorizations
AuthorizationstringRequired

API key sent as a bearer token (mk_live_… / mk_test_…).

Path parameters
productGroupIdstringRequired

Product group identifier (PG-).

Example: PG-123e4567-e89b-12d3-a456-426614174000Pattern: ^PG-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Body

Data schema used by Update Product Group (PUT /v1/product-groups/{productGroupId}). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ.

namestring · min: 1 · max: 255Optional

Product group name.

Example: Chairs
manualSortbooleanOptional
statusstring · enumOptionalPossible values:
Responses
200

Successful response.

application/json
put/v1/product-groups/{productGroupId}
PUT /v1/product-groups/{productGroupId} HTTP/1.1
Host: admin.mimeeqapi.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 53

{
  "name": "Chairs",
  "manualSort": true,
  "status": "ACTIVE"
}
{
  "data": {
    "productGroupId": "PG-123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "type": "SHARED",
    "status": "ACTIVE",
    "numberOfProducts": 1,
    "numberOfCompanies": 1,
    "manualSort": true,
    "companyIds": [
      "text"
    ],
    "connectedProducts": [
      {
        "productId": "text",
        "name": "text",
        "status": "text"
      }
    ]
  }
}

Last updated

Was this helpful?