MetafieldDefinitions

post/api/v1.0/{appId}/metafields/definitions/{ownerEntity}

Request

  • Base URL: https://api.flipdish.co
  • URL: https://api.flipdish.co/api/v1.0/{appId}/metafields/definitions/{ownerEntity}
  • Auth: OAuth 2 (implicit, authorization URL https://api.flipdish.co/identity/connect/authorize, scopes: api)

Path parameters

appIdstring required
ownerEntity'CatalogItem' | 'CatalogGroup' | 'Menu' required

Request body

IsReadOnlyboolean

Indicates if a definition can be edited or not

OwnerEntity'CatalogItem' | 'CatalogGroup' | 'Menu'

The Metafield will extend the specified {Flipdish.Metafields.PublicModels.V1.MetafieldDefinitionBase.OwnerEntity}

Keystring required

Key of the metafield. The key must have two parts, separated by a dot. The first part acts as a category, for organizational purposes. The parts can be composed of lowercase letters, numbers, hyphen and underscore

ValueType'Boolean' | 'Json' | 'SingleLineString' | 'MultiLineString'

The excepted type for the Value field

Namestring required

Field Name

Descriptionstring

Field Description

Behaviorsstring[]

Enable Metafield Behaviors

MetafieldDefinitionRecommendationIdinteger nullable

Metafield Recommendation Id

Response

OK

Changes

No recorded changes to this operation across all 12 revisions of this API.