v1

latestOpenAPI 3.0.32026-08-067332206.6 KB

custom_fields

Create custom field keys

Creates custom field keys for the matching brandfolder.

This endpoint is only needed for setting up controlled Custom Fields. If this is enabled for your Brandfolder, you can set the allowed keys and optionally restrict their allowed values for Custom Fields using this endpoint.

post/brandfolders/{brandfolder_id}/custom_field_keys

Request body

Example request

{
  "data": {
    "attributes": [
      {
        "name": "color",
        "allowed_values": [
          "red",
          "white",
          "blue"
        ],
        "restricted": true
      }
    ]
  }
}

Response

The new custom field keys.

Example response

{
  "data": [
    {
      "id": "plqlkk-22rw6g-3dqgx0",
      "attributes": {
        "name": "color",
        "allowed_values": [
          "red",
          "white",
          "blue"
        ],
        "restricted": true
      }
    }
  ],
  "meta": {
    "current_page": 1,
    "total_pages": 1,
    "total_count": 1
  }
}