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

Add Product Group Companies

Connect additional companies without sending the whole list (SHARED groups only; returns 400 for an EMBED group).

Use this to add the supplied members without submitting the entire existing list. Review how matching IDs are handled below.

Behaviour

Ids already connected are ignored; 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.

Connected products are left untouched.

Requires the productGroups:write scope.

post
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 Add Product Group Companies (POST /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[] · min: 1Required

Company identifier (COMP-).

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

Successful response.

application/json
post/v1/product-groups/{productGroupId}/companies
POST /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"
      }
    ]
  }
}

Last updated

Was this helpful?