---
title: "Create option"
url: "https://earlyaccess.developers.bynder.com/apis/metaproperty-options-1/versions/9b6f896a-c5dd-4f1a-a8e4-591e5ef4f1db/operations/postApi1TaxonomyMetapropertiesMetapropertyidOptions"
---

> Full API specification: https://earlyaccess.developers.bynder.com/apis/metaproperty-options-1/versions/9b6f896a-c5dd-4f1a-a8e4-591e5ef4f1db.md

# Create option

`POST` `/api/1/taxonomy/metaproperties/{metapropertyId}/options`

Operation ID: `postApi1TaxonomyMetapropertiesMetapropertyidOptions`

Create a new option. Note: when the `name` you provide differs from the option's label, Bynder automatically assigns that `name` value as the option's `externalReference`. Explicitly setting `externalReference` to `null` or an empty string does not prevent this. To store a specific external reference, pass the desired value in the `externalReference` field.

## Path parameters

- `metapropertyId` (string, uuid, required)

## Request body (required)

Content types: `application/json`

## Responses

- `200`
- `201`
- `400`
- `404`

## OpenAPI definition

```yaml
openapi: 3.1.0
info:
  title: Metaproperty options
  version: "1.0"
servers:
  - url: https://{your-bynder-domain}/
paths:
  /api/1/taxonomy/metaproperties/{metapropertyId}/options:
    post:
      description: >-
        Create a new option.


        Note: when the `name` you provide differs from the option's label,
        Bynder automatically assigns that `name` value as the option's
        `externalReference`. Explicitly setting `externalReference` to `null` or
        an empty string does not prevent this. To store a specific external
        reference, pass the desired value in the `externalReference` field.
      operationId: postApi1TaxonomyMetapropertiesMetapropertyidOptions
      parameters:
        - in: path
          name: metapropertyId
          required: true
          schema:
            format: uuid
            type: string
      requestBody:
        content:
          application/json:
            schema:
              properties:
                definition:
                  type: string
                externalReference:
                  type: string
                icon:
                  type: string
                name:
                  type: string
              required:
                - name
              title: MetapropertyOptionInput
              type: object
        required: true
      responses:
        "200":
          content:
            application/json:
              examples:
                ExistingOptionStreamOutput:
                  summary: Response when the option already exists
                  value:
                    icon: ""
                    id: 00000000-0000-0000-0000-000000000001
                    name: Option 1
                    status: existing
              schema:
                properties:
                  definition:
                    type: string
                  icon:
                    type: string
                  id:
                    format: uuid
                    type: string
                  name:
                    type: string
                  status:
                    type: string
                required:
                  - id
                  - name
                  - status
                  - icon
                title: ExistingOptionStreamOutput
                type: object
          description: ""
        "201":
          content:
            application/json:
              examples:
                CreatedOptionStreamOutput:
                  summary: Response when the option is newly created
                  value:
                    externalReference: ext-ref-1
                    icon: ""
                    id: 00000000-0000-0000-0000-000000000001
                    name: Option 1
                    status: created
              schema:
                properties:
                  definition:
                    type: string
                  externalReference:
                    type: string
                  icon:
                    type: string
                  id:
                    format: uuid
                    type: string
                  name:
                    type: string
                  status:
                    type: string
                required:
                  - externalReference
                  - id
                  - name
                  - status
                  - icon
                title: CreatedOptionStreamOutput
                type: object
          description: ""
        "400":
          content:
            application/json:
              examples:
                CannotCreateOptionOutput:
                  summary: Response when the option cannot be created because of the metaproperty
                    type
                  value:
                    errorCode: cannot-create-options
                    message: Cannot create options for this metaproperty type
                InvalidOptionOutput:
                  summary: Response when the option is invalid
                  value:
                    errorCode: validation-errors
                    errors: []
                    message: Issues found while validating the request
              schema:
                properties:
                  errorCode:
                    type: string
                  errors:
                    items:
                      properties:
                        errorCode:
                          type: string
                        message:
                          type: string
                      required:
                        - errorCode
                        - message
                      title: ErrorMessage
                      type: object
                    type: array
                  message:
                    type: string
                title: OptionCreateInvalidOutput
                type: object
          description: ""
        "404":
          content:
            application/json:
              examples:
                MetapropertyNotExisting:
                  summary: Response when the metaproperty does not exist
                  value:
                    errorCode: metaproperty-not-existing
                    message: Metaproperty does not exist
              schema:
                properties:
                  errorCode:
                    type: string
                  message:
                    type: string
                required:
                  - errorCode
                  - message
                title: MetapropertyNotExistingOutput
                type: object
          description: ""
      summary: Create option
      tags:
        - Options - New API (Preferred)
security:
  - OAuth2:
      - METAPROPERTYMANAGEMENT
      - METAMANAGEMENT
  - permanentToken:
      - METAPROPERTYMANAGEMENT
      - METAMANAGEMENT
components:
  securitySchemes:
    OAuth2:
      flows:
        authorizationCode:
          authorizationUrl: https://{your-auth-url}
          scopes:
            METAMANAGEMENT: ""
            METAPROPERTYMANAGEMENT: ""
          tokenUrl: https://{your-bynder-domain}/v6/authentication/oauth2/token
        clientCredentials:
          scopes:
            METAMANAGEMENT: ""
            METAPROPERTYMANAGEMENT: ""
          tokenUrl: https://{your-bynder-domain}/v6/authentication/oauth2/token
      type: oauth2
    permanentToken:
      in: header
      name: Authorization
      type: apiKey
```
