Documentation Index
Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt
Use this file to discover all available pages before exploring further.
Server path: /bynder-metadata | Type: Application | PCID required: Yes
Create a metaproperty
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
isFilterable | boolean | No | — | Whether this metaproperty can be used as a filter |
isRequired | boolean | No | — | Whether this metaproperty is required when uploading assets |
isSearchable | boolean | No | — | Whether this metaproperty is searchable |
label | string | No | — | Label for the metaproperty |
name | string | Yes | — | Display name of the metaproperty |
type | string | Yes | — | Type of metaproperty: select, multiselect, text, longtext, date, number |
zindex | integer | No | — | Display order position |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"isFilterable": {
"type": "boolean",
"description": "Whether this metaproperty can be used as a filter"
},
"isRequired": {
"type": "boolean",
"description": "Whether this metaproperty is required when uploading assets"
},
"isSearchable": {
"type": "boolean",
"description": "Whether this metaproperty is searchable"
},
"label": {
"type": "string",
"description": "Label for the metaproperty"
},
"name": {
"type": "string",
"description": "Display name of the metaproperty"
},
"type": {
"type": "string",
"description": "Type of metaproperty: select, multiselect, text, longtext, date, number"
},
"zindex": {
"type": "integer",
"description": "Display order position"
}
},
"required": [
"PCID",
"name",
"type"
]
}
Create a metaproperty option
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
id | string | Yes | — | Metaproperty identifier |
label | string | No | — | Label for the option |
name | string | Yes | — | Display name of the option |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "Metaproperty identifier"
},
"label": {
"type": "string",
"description": "Label for the option"
},
"name": {
"type": "string",
"description": "Display name of the option"
}
},
"required": [
"PCID",
"id",
"name"
]
}
Delete a metaproperty
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
id | string | Yes | — | Metaproperty identifier |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "Metaproperty identifier"
}
},
"required": [
"PCID",
"id"
]
}
Delete a metaproperty option
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
id | string | Yes | — | Metaproperty identifier |
optionId | string | Yes | — | Option identifier |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "Metaproperty identifier"
},
"optionId": {
"type": "string",
"description": "Option identifier"
}
},
"required": [
"PCID",
"id",
"optionId"
]
}
Retrieve a specific metaproperty
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
id | string | Yes | — | Metaproperty identifier |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "Metaproperty identifier"
}
},
"required": [
"PCID",
"id"
]
}
Retrieve global option dependencies
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
Retrieve metaproperties
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
count | boolean | No | — | Include asset count results for metaproperty options |
type | string | No | — | Comma-separated list of asset types to filter count results: image, document, audio, video, 3d |
options | boolean | No | — | Include metaproperty options in the response (set to 0 to exclude for better performance) |
ids | string | No | — | Comma-separated list of metaproperty IDs to retrieve specific metaproperties |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"count": {
"type": "boolean",
"description": "Include asset count results for metaproperty options"
},
"type": {
"type": "string",
"description": "Comma-separated list of asset types to filter count results: image, document, audio, video, 3d"
},
"options": {
"type": "boolean",
"description": "Include metaproperty options in the response (set to 0 to exclude for better performance)"
},
"ids": {
"type": "string",
"description": "Comma-separated list of metaproperty IDs to retrieve specific metaproperties"
}
},
"required": [
"PCID"
]
}
Retrieve metaproperty option dependencies
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
id | string | Yes | — | Metaproperty identifier |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "Metaproperty identifier"
}
},
"required": [
"PCID",
"id"
]
}
Retrieve metaproperty options
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
id | string | Yes | — | Metaproperty identifier |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "Metaproperty identifier"
}
},
"required": [
"PCID",
"id"
]
}
Retrieve metaproperty options by IDs
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
ids | string | Yes | — | Comma-separated list of option IDs |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"ids": {
"type": "string",
"description": "Comma-separated list of option IDs"
}
},
"required": [
"PCID",
"ids"
]
}
Retrieve smartfilters
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
Modify a metaproperty
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
id | string | Yes | — | Metaproperty identifier |
isFilterable | boolean | No | — | Whether this metaproperty can be used as a filter |
isRequired | boolean | No | — | Whether this metaproperty is required |
isSearchable | boolean | No | — | Whether this metaproperty is searchable |
label | string | No | — | Updated label |
name | string | No | — | Updated display name |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "Metaproperty identifier"
},
"isFilterable": {
"type": "boolean",
"description": "Whether this metaproperty can be used as a filter"
},
"isRequired": {
"type": "boolean",
"description": "Whether this metaproperty is required"
},
"isSearchable": {
"type": "boolean",
"description": "Whether this metaproperty is searchable"
},
"label": {
"type": "string",
"description": "Updated label"
},
"name": {
"type": "string",
"description": "Updated display name"
}
},
"required": [
"PCID",
"id"
]
}
Modify a metaproperty option
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
id | string | Yes | — | Metaproperty identifier |
optionId | string | Yes | — | Option identifier |
label | string | No | — | Updated label |
name | string | No | — | Updated display name |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "Metaproperty identifier"
},
"optionId": {
"type": "string",
"description": "Option identifier"
},
"label": {
"type": "string",
"description": "Updated label"
},
"name": {
"type": "string",
"description": "Updated display name"
}
},
"required": [
"PCID",
"id",
"optionId"
]
}