Create Collection Set

Create a collection set.

Use this to create a reusable collection set in your account. Inspect the returned record before continuing the synchronization.

Behaviour

Only the name is required; you may also pass the general fields (status, tags) and member option sets to build the whole set in one call.

Extras are applied by a follow-up update after the set exists; if that step fails the set is still created and the response shows it without them.

New sets default to INACTIVE.

Returns 409 if the name already exists.

Requires the collectionSets:write scope.

post

Authorizations

AuthorizationstringRequired

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

Body

Data schema used by Create Collection Set (POST /v1/collection-sets). 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: 255Required

Collection set name.

Example: Summer Collection

statusstring · enumOptionalPossible values:

tagsstring[]Optional

optionSetIdsstring[]Optional

Member option set identifier (OPT-).

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

Responses

201

Created.

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

409

Conflict with the current state (e.g. the resource already exists).

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

post/v1/collection-sets

POST /v1/collection-sets HTTP/1.1
Host: admin.mimeeqapi.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 122

{
  "name": "Summer Collection",
  "status": "ACTIVE",
  "tags": [
    "text"
  ],
  "optionSetIds": [
    "OPT-123e4567-e89b-12d3-a456-426614174000"
  ]
}

{
  "data": {
    "collectionSetId": "MCS-123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "status": "ACTIVE",
    "createdAt": "text",
    "modifiedAt": "text",
    "tags": [
      "text"
    ],
    "optionSets": [
      {
        "optionSetId": "text",
        "name": "text",
        "status": "text"
      }
    ]
  }
}