> For the complete documentation index, see [llms.txt](https://help.mimeeq.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.mimeeq.com/api/product-groups/update-product-group.md).

# 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.

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.1.0"},"tags":[{"name":"Product Groups","description":"Group configurable products for sharing or embedding. A `SHARED` group connects a product selection to companies; an `EMBED` group holds products for an embedding workflow.\n\nUse this section to manage which products are grouped together and, for shared groups, which companies are connected. Use Product Categories for catalogue hierarchy and Products for product configuration.\n\n## What you can do\n\n| Task | Reference |\n| --- | --- |\n| Find available product groups | [List Product Groups](https://help.mimeeq.com/developers/product-groups/list-product-groups) |\n| Add a new product group | [Create Product Group](https://help.mimeeq.com/developers/product-groups/create-product-group) |\n| Read one product group | [Get Product Group](https://help.mimeeq.com/developers/product-groups/get-product-group) |\n| Change product group | [Update Product Group](https://help.mimeeq.com/developers/product-groups/update-product-group) |\n| Change product group products | [Update Product Group Products](https://help.mimeeq.com/developers/product-groups/update-product-group-products) |\n| Add Product Group Products | [Add Product Group Products](https://help.mimeeq.com/developers/product-groups/add-product-group-products) |\n| Remove Product Group Products | [Remove Product Group Products](https://help.mimeeq.com/developers/product-groups/remove-product-group-products) |\n| Change product group companies | [Update Product Group Companies](https://help.mimeeq.com/developers/product-groups/update-product-group-companies) |\n| Add Product Group Companies | [Add Product Group Companies](https://help.mimeeq.com/developers/product-groups/add-product-group-companies) |\n| Remove Product Group Companies | [Remove Product Group Companies](https://help.mimeeq.com/developers/product-groups/remove-product-group-companies) |\n| Copy product group | [Duplicate Product Group](https://help.mimeeq.com/developers/product-groups/duplicate-product-group) |\n\n## Before you start\n\nYour API key needs `productGroups:read` to read these resources. Use `productGroups:write` for write operations.\n\n## Important behaviour\n\nChoose the group type when creating it; general updates do not change that type. Company membership is only available on `SHARED` groups and connected companies need an API key. PUT replaces a full membership list; POST adds members; the remove operations disconnect selected members. Array order controls manual product ordering."}],"servers":[{"url":"https://admin.mimeeqapi.com","description":"Production API"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"http","scheme":"bearer","description":"API key sent as a bearer token (mk_live_… / mk_test_…)."}},"schemas":{"ProductGroupsDetail":{"type":"object","properties":{"data":{"type":"object","properties":{"productGroupId":{"type":"string","pattern":"^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}$","description":"Product group identifier (PG-<uuid>)."},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"type":{"anyOf":[{"type":"string","enum":["SHARED","EMBED"]},{"type":"null"}]},"status":{"anyOf":[{"type":"string","enum":["ACTIVE","INACTIVE"]},{"type":"null"}]},"numberOfProducts":{"type":"number"},"numberOfCompanies":{"type":"number","description":"Connected companies — applies to SHARED groups only; always 0 for EMBED."},"manualSort":{"type":"boolean","description":"Whether products are sorted manually. Defaults to true."},"companyIds":{"type":"array","items":{"type":"string"},"description":"Connected company ids — applies to SHARED groups only; always empty for EMBED."},"connectedProducts":{"type":"array","items":{"type":"object","properties":{"productId":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["productId","name","status"],"additionalProperties":false}}},"required":["productGroupId","name","type","status","numberOfProducts","numberOfCompanies","manualSort","companyIds","connectedProducts"],"additionalProperties":false}},"required":["data"],"additionalProperties":false,"description":"Data schema used by Get Product Group (GET /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."},"PublicError":{"description":"An API error response. Use code and the HTTP status to classify the failure, message and optional details for context, and requestId when reporting it. Edge firewall responses may omit requestId.","type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"requestId":{"type":"string","description":"Present on every error the API itself returns; absent when the edge firewall rejected the request."},"details":{"description":"Optional error-specific details (e.g. per-field validation reasons)."}}},"ProductGroupsUpdateRequest":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":255,"description":"Product group name."},"manualSort":{"type":"boolean"},"status":{"type":"string","enum":["ACTIVE","INACTIVE"]}},"additionalProperties":false,"description":"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."}}},"paths":{"/v1/product-groups/{productGroupId}":{"put":{"summary":"Update Product Group","tags":["Product Groups"],"description":"Update the general fields (name, manual-sort flag, status).\n\nRead the existing product group first. Check the replacement rules below before sending a partial list or localized value.\n\n## Behaviour\n\nOnly the fields you send are changed; omitted fields keep their stored value.\n\nConnected products/companies and type are preserved.\n\nRequires the `productGroups:write` scope.","responses":{"200":{"description":"Successful response.","headers":{"RateLimit-Limit":{"description":"Requests that can be admitted at once (the tier burst).","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Tokens left after this request.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the bucket is full again.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductGroupsDetail"}}}},"400":{"description":"Invalid request data.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicError"}}},"headers":{"RateLimit-Limit":{"description":"Requests that can be admitted at once (the tier burst).","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Tokens left after this request.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the bucket is full again.","schema":{"type":"integer"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicError"}}}},"403":{"description":"The API key lacks the required scope (`scope_denied`), or the operation is not permitted for this account (`operation_not_permitted`).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicError"}}},"headers":{"RateLimit-Limit":{"description":"Requests that can be admitted at once (the tier burst).","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Tokens left after this request.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the bucket is full again.","schema":{"type":"integer"}}}},"404":{"description":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicError"}}},"headers":{"RateLimit-Limit":{"description":"Requests that can be admitted at once (the tier burst).","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Tokens left after this request.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the bucket is full again.","schema":{"type":"integer"}}}},"429":{"description":"The API key exceeded its request rate (`rate_limit_exceeded`) or its monthly quota (`quota_exceeded`). Both carry `Retry-After`; the `RateLimit-*` headers accompany `rate_limit_exceeded` only, since a spent quota says nothing about the bucket.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicError"}}},"headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}},"RateLimit-Limit":{"description":"Requests that can be admitted at once (the tier burst).","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Tokens left after this request.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the bucket is full again.","schema":{"type":"integer"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicError"}}},"headers":{"RateLimit-Limit":{"description":"Requests that can be admitted at once (the tier burst).","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Tokens left after this request.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the bucket is full again.","schema":{"type":"integer"}}}}},"parameters":[{"name":"productGroupId","in":"path","required":true,"schema":{"type":"string","pattern":"^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}$","description":"Product group identifier (PG-<uuid>)."}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductGroupsUpdateRequest"}}}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://help.mimeeq.com/api/product-groups/update-product-group.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.