Metaproperty options

Modify option

Modify an option by id

patch
https://{your-bynder-domain}/api/1/taxonomy/metaproperties/{metapropertyId}/options/{optionId}

Path Parameters

metapropertyIdstring(uuid)required
optionIdstring(uuid)required

Body

application/json

MetapropertyOptionUpdateInput

definitionstring
externalReferencestring
iconstring
namestring

Response

application/json

OptionUpdatedOutput

messagestringrequired
patch/api/1/taxonomy/metaproperties/{metapropertyId}/options/{optionId}

Body

{}
 
application/json

Options - Old API (Please use new API if possible)

Retrieve options by ids

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

Query Parameters

idsstringrequired

Example:00000000-0000-0000-0000000000000000,00000000-0000-0000-0000000000000000

Response

application/json

A list of options

get/api/v4/metaproperties/options
 
application/json

Retrieve options for a metaproperty

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

Query Parameters

namestring

Example:Amsterdam

limitinteger

Default:50

<= 1000

Example:250

pageinteger

Default:1

Example:1

externalReferencestring

Path Parameters

idstringrequired

Example:00000000-0000-0000-0000000000000000

Response

application/json

Successful response

activeinteger

Example:1

datestring(date-time)

Example:2017-02-15T14:54:58+00:00

displayLabelstring

Example:Yellow

idstring

Example:00000000-0000-0000-0000000000000000

labelstring

Example:Yellow

labelsobject
Show Child Parameters
namestring

Example:yellow

get/api/v4/metaproperties/{id}/options
 
application/json

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