Update Global Option Set

Update the general fields (name, localized display name, description, status, tags).

Read the existing global option set 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.

Send description: null to clear it.

Options are managed via their own endpoint.

Requires the globalOptionSets:write scope.

put

Authorizations

AuthorizationstringRequired

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

Path parameters

optionSetIdstringRequired

Global option set identifier (OPT-).

Example: OPT-123e4567-e89b-12d3-a456-426614174000Pattern: ^OPT-[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 Global Option Set (PUT /v1/global-option-sets/{optionSetId}). 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

Option set name (internal, not localized).

Example: Colour

statusstring · enumOptionalPossible values:

tagsstring[]Optional

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/global-option-sets/{optionSetId}

PUT /v1/global-option-sets/{optionSetId} HTTP/1.1
Host: admin.mimeeqapi.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 156

{
  "name": "Colour",
  "displayName": {
    "en": "Colour",
    "de": "Farbe"
  },
  "description": {
    "en": "Pick a colour",
    "de": "Wähle eine Farbe"
  },
  "status": "ACTIVE",
  "tags": [
    "text"
  ]
}

{
  "data": {
    "optionSetId": "OPT-123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "displayName": "Chair",
    "description": "Chair",
    "status": "ACTIVE",
    "numberOfOptions": 1,
    "createdAt": "text",
    "modifiedAt": "text",
    "tags": [
      "text"
    ],
    "options": [
      {
        "id": "text",
        "code": "text",
        "name": "Chair",
        "comment": "Chair",
        "priceCode": "text",
        "fbPriceCode": "text",
        "additionalPriceCode": "text",
        "material3dId": "text",
        "arMaterial3dId": "text",
        "additionalPriceCodeQuantity": 1,
        "filters": {
          "<parameterId>": [
            "<valueId>"
          ]
        },
        "metafields": {
          "lead-time-weeks": 10,
          "care-label": "Wipe clean"
        },
        "src": "text"
      }
    ]
  }
}