Update Product Group Companies

Replace the full list of connected companies (SHARED groups only; returns 400 for an EMBED group).

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

Behaviour

Companies omitted from the list are disconnected; companies that are not yours are ignored.

Every company you list must already have an API key, otherwise the call returns 400 company_api_key_missing naming the ones that do not — sharing has no effect without one.

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 Companies (PUT /v1/product-groups/{productGroupId}/companies). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ.

companyIdsstring[]Required

Company identifier (COMP-).

Example: COMP-123e4567-e89b-12d3-a456-426614174000

Responses

200

Successful response.

application/json

400

Invalid request data.

application/json

401

Missing or invalid API key.

application/json

403

The API key lacks the required scope (scope_denied), or the operation is not permitted for this account (operation_not_permitted).

application/json

404

Resource not found.

application/json

429

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.

application/json

500

Internal server error.

application/json

put/v1/product-groups/{productGroupId}/companies

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

{
  "companyIds": [
    "COMP-123e4567-e89b-12d3-a456-426614174000"
  ]
}

{
  "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"
      }
    ]
  }
}