Skip to content

Update a field

Request

Update a Field resource.

Security
bearerToken
Path
idstringrequired

The unique ID of the field

Example:cfb665ca-ce35-4418-b9d5-70ee815db4bd
Bodyapplication/jsonrequired
namestring or null

Human-readable name of the Field

Example:"Folders"
contributorsCanCreateFieldOptionsboolean or null

If true, admins and contributors can create FieldOption resources for this Field. If false, FieldOption creation uses the existing folder-specific permission logic.

Example:true
recommendedboolean or null

If true it is recommended for assets to have a value for this Field. Clients should highlight missing recommended values during creation and editing of assets. Clients can also use the FIELD_IS_EMPTY criterion in an AssetSearch to find assets with missing recommended values.

Example:true
defaultSortFieldobject or null

The sort to use when searching for FieldOptions related to this Field if no sort is provided.

browsableboolean or null

Whether assets with a value for this Field can be browsed in the Browse page. Note that this option cannot be changed for Folder fields or non-fixed-option fields.

Example:false
curl -i -X PATCH \
  https://api-v2.dash.app/fields/cfb665ca-ce35-4418-b9d5-70ee815db4bd \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Folders",
    "contributorsCanCreateFieldOptions": true,
    "recommended": true,
    "defaultSortField": {
      "value": "FIELD_ID"
    },
    "browsable": false
  }'

Responses

Success

Bodyapplication/json
resultobjectrequired
permittedActionsArray of objectsrequired
Response
{
  "result": {
    "id": "a52b5315-15b8-417f-b742-d6902108bac1",
    "accountId": "cfb665ca-ce35-4418-b9d5-70ee815db4bd",
    "name": "Folders",
    "dataType": "STRING",
    "multiValue": true,
    "hasFixedOptions": true,
    "hierarchical": true,
    "editControl": "FOLDER_PICKER",
    "contributorsCanCreateFieldOptions": true,
    "indestructible": true,
    "recommended": true,
    "defaultSortField": "FIELD_ID",
    "browsable": true,
    "entityType": "ASSET",
    "lookupType": "PRODUCT_VARIANT_CRITERION"
  },
  "permittedActions": [
    { … }
  ]
}