Metaproperty options

Create option

Requires the METAPROPERTYMANAGEMENT or METAMANAGEMENT security role.

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.

post
https://{your-bynder-domain}/api/v4/metaproperties/{id}/options

Path Parameters

idstringrequired

Example:00000000-0000-0000-0000000000000000

Body

application/x-www-form-urlencoded
datastring

JSON-serialised string

Example:{"name": "BlueType", "externalReference": "Reference number 1", "label": "Blue", "labels": {"fr_FR": "foo", "en_US": "foo"}, "zindex": 4, "isSelectable": true, "parentId": "00000000-0000-0000-0000000000000000", "options": [{"name": "BlueType", "label": "Blue", "labels": {"fr_FR": "foo", "en_US": "foo"}, "zindex": 4, "isSelectable": true, "parentId": "00000000-0000-0000-0000000000000000"}]}

Response

application/json

Created

idstring

Example:00000000-0000-0000-0000000000000000

messagestring

Example:Created

statuscodeinteger

Example:201

post/api/v4/metaproperties/{id}/options

Body

{}
 
application/json

Delete option

delete
https://{your-bynder-domain}/api/v4/metaproperties/{id}/options/{optionId}

Path Parameters

idstringrequired

Example:00000000-0000-0000-0000000000000000

optionIdstringrequired

Example:00000000-0000-0000-0000000000000000

Response

application/json

No Content

delete/api/v4/metaproperties/{id}/options/{optionId}
 
application/json

Modify option

Modify a specific option.

post
https://{your-bynder-domain}/api/v4/metaproperties/{id}/options/{optionId}

Path Parameters

idstringrequired

Example:00000000-0000-0000-0000000000000000

optionIdstringrequired

Example:00000000-0000-0000-0000000000000000

Body

application/x-www-form-urlencoded
datastring

JSON-serialised string

Example:{"label": "Blue", "externalReference": "Reference number 1", "labels": {"fr_FR": "foo", "en_US": "foo"}, "zindex": 4, "isSelectable": true, "parentId": "00000000-0000-0000-0000000000000000"}

Response

application/json

Created

messagestring

Example:Created

statuscodeinteger

Example:201

post/api/v4/metaproperties/{id}/options/{optionId}

Body

{}
 
application/json

CannotCreateOptionOutput

object
errorCodestringrequired
messagestringrequired
Example

CreatedOptionStreamOutput

object
definitionstring
externalReferencestringrequired
iconstringrequired
idstring(uuid)required
namestringrequired
statusstringrequired
Example