> 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/global-option-sets/create-global-option-set.md).

# Create Global Option Set

Create a global option set.

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

### Behaviour

Only the name and localized display name are required; you may also pass the general fields (description, status, tags) and the options to build the whole set in one call.

Extras are applied by follow-up update(s) after the set exists; if a step fails the set is still created and the response shows it without them, so compare the response with what you sent.

Send `description: null` to leave it empty.

Requires the `globalOptionSets:write` scope.

```json
{"openapi":"3.1.0","info":{"title":"Mimeeq External API","version":"1.1.0"},"tags":[{"name":"Global Option Sets","description":"Manage reusable option sets belonging to your Mimeeq account. An option set contains choices and their metadata that can be used in product configurators.\n\nUse this section to maintain shared choices such as finishes or materials, instead of maintaining equivalent option data separately. Collection Sets group option sets; Custom Fields defines additional fields carried by options.\n\n## What you can do\n\n| Task | Reference |\n| --- | --- |\n| Find available global option sets | [List Global Option Sets](https://help.mimeeq.com/developers/global-option-sets/list-global-option-sets) |\n| Add a new global option set | [Create Global Option Set](https://help.mimeeq.com/developers/global-option-sets/create-global-option-set) |\n| Read one global option set | [Get Global Option Set](https://help.mimeeq.com/developers/global-option-sets/get-global-option-set) |\n| Change global option set | [Update Global Option Set](https://help.mimeeq.com/developers/global-option-sets/update-global-option-set) |\n| Change global option set options | [Update Global Option Set Options](https://help.mimeeq.com/developers/global-option-sets/update-global-option-set-options) |\n| Add or Update Global Option Set Options | [Add or Update Global Option Set Options](https://help.mimeeq.com/developers/global-option-sets/add-or-update-global-option-set-options) |\n| Remove Global Option Set Options | [Remove Global Option Set Options](https://help.mimeeq.com/developers/global-option-sets/remove-global-option-set-options) |\n| Copy global option set | [Duplicate Global Option Set](https://help.mimeeq.com/developers/global-option-sets/duplicate-global-option-set) |\n\n## Before you start\n\nYour API key needs `globalOptionSets:read` to read these resources. Use `globalOptionSets:write` for write operations.\n\n## Important behaviour\n\nGeneral settings and option membership have separate operations. PUT on the options list replaces every option; POST adds or replaces the options supplied; the remove operation removes selected IDs. A submitted option is a complete value, not a partial field patch. Preserve its other fields and translations when editing it. List responses are localized; Get without lang returns complete translation maps."}],"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":{"GlobalOptionSetsMutation":{"type":"object","properties":{"data":{"type":"object","properties":{"optionSetId":{"type":"string","pattern":"^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}$","description":"Global option set identifier (OPT-<uuid>)."},"name":{"type":"string"},"displayName":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}}]},{"type":"null"}],"description":"Translated text when `lang` is set, otherwise the full `{ language: text }` map. Languages with no text are omitted, and a field with no text at all is null."},"description":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}}]},{"type":"null"}],"description":"Translated text when `lang` is set, otherwise the full `{ language: text }` map. Languages with no text are omitted, and a field with no text at all is null."},"status":{"type":"string","enum":["ACTIVE","INACTIVE"]},"numberOfOptions":{"anyOf":[{"type":"number"},{"type":"null"}]},"createdAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"modifiedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"tags":{"type":"array","items":{"type":"string"}},"options":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"code":{"type":"string"},"name":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}}]},{"type":"null"}],"description":"Translated text when `lang` is set, otherwise the full `{ language: text }` map. Languages with no text are omitted, and a field with no text at all is null."},"comment":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}}]},{"type":"null"}],"description":"Translated text when `lang` is set, otherwise the full `{ language: text }` map. Languages with no text are omitted, and a field with no text at all is null."},"priceCode":{"anyOf":[{"type":"string"},{"type":"null"}]},"fbPriceCode":{"anyOf":[{"type":"string"},{"type":"null"}]},"additionalPriceCode":{"anyOf":[{"type":"string"},{"type":"null"}]},"material3dId":{"anyOf":[{"type":"string"},{"type":"null"}]},"arMaterial3dId":{"anyOf":[{"type":"string"},{"type":"null"}]},"additionalPriceCodeQuantity":{"anyOf":[{"anyOf":[{"type":"number"},{"type":"string"}]},{"type":"null"}],"description":"Quantity the `additionalPriceCode` applies to."},"filters":{"anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{},"description":"Opaque filter configuration: parameter id -> selected value ids. Structure is configuration-dependent."},{"type":"null"}]},"metafields":{"anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{},"description":"Opaque metafield map of customer-defined keys to values (string, number, or object)."},{"type":"null"}]},"src":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Absolute URL of the option image, resolved against the CDN."}},"required":["id","code","name","comment","priceCode","fbPriceCode","additionalPriceCode","material3dId","arMaterial3dId","additionalPriceCodeQuantity","filters","metafields","src"],"additionalProperties":false}}},"required":["optionSetId"],"additionalProperties":false}},"required":["data"],"additionalProperties":false,"description":"Data schema used by Create Global Option Set (POST /v1/global-option-sets). 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)."}}},"GlobalOptionSetsCreateRequest":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":255,"description":"Option set name (internal, not localized)."},"displayName":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"},"description":"Display name, keyed by language code."},"description":{"anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},{"type":"null"}]},"status":{"type":"string","enum":["ACTIVE","INACTIVE"]},"tags":{"type":"array","items":{"type":"string","minLength":1,"maxLength":255}},"options":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":255,"description":"Client-supplied option id; reuse the stored id to update an existing option."},"code":{"type":"string","minLength":1,"maxLength":255},"name":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"comment":{"anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},{"type":"null"}]},"priceCode":{"anyOf":[{"type":"string"},{"type":"null"}]},"fbPriceCode":{"anyOf":[{"type":"string"},{"type":"null"}]},"additionalPriceCode":{"anyOf":[{"type":"string"},{"type":"null"}]},"material3dId":{"anyOf":[{"type":"string"},{"type":"null"}]},"arMaterial3dId":{"anyOf":[{"type":"string"},{"type":"null"}]},"additionalPriceCodeQuantity":{"anyOf":[{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"string","minLength":1}],"description":"Quantity the `additionalPriceCode` applies to."},{"type":"null"}]},"filters":{"anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{},"description":"Opaque filter configuration: parameter id -> selected value ids. Structure is configuration-dependent."},{"type":"null"}]},"metafields":{"anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{},"description":"Opaque metafield map of customer-defined keys to values (string, number, or object)."},{"type":"null"}]},"src":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]}},"required":["id","code","name"],"additionalProperties":false}}},"required":["name","displayName"],"additionalProperties":false,"description":"Data schema used by Create Global Option Set (POST /v1/global-option-sets). 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/global-option-sets":{"post":{"summary":"Create Global Option Set","tags":["Global Option Sets"],"description":"Create a global option set.\n\nUse this to create a reusable global option set in your account. Inspect the returned record before continuing the synchronization.\n\n## Behaviour\n\nOnly the name and localized display name are required; you may also pass the general fields (description, status, tags) and the options to build the whole set in one call.\n\nExtras are applied by follow-up update(s) after the set exists; if a step fails the set is still created and the response shows it without them, so compare the response with what you sent.\n\nSend `description: null` to leave it empty.\n\nRequires the `globalOptionSets:write` scope.","responses":{"201":{"description":"Created.","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/GlobalOptionSetsMutation"}}}},"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"}}}},"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"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GlobalOptionSetsCreateRequest"}}}}}}}}
```


---

# 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/global-option-sets/create-global-option-set.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.