Flipdish · Schema

UpdateMetafieldDefinition

Information to update a {Flipdish.Metafields.PublicModels.V1.MetafieldDefinition}

RestaurantOnline OrderingMobile AppsPoint of SaleOrdersMenuPaymentsWebhooks

Properties

Name Type Description
Name string Field Name
Description string Field Description
Behaviors array Enable Metafield Behaviors
View JSON Schema on GitHub

JSON Schema

catalog-update-metafield-definition-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/flipdish/refs/heads/main/json-schema/catalog-update-metafield-definition-schema.json",
  "title": "UpdateMetafieldDefinition",
  "description": "Information to update a {Flipdish.Metafields.PublicModels.V1.MetafieldDefinition}",
  "type": "object",
  "properties": {
    "Name": {
      "description": "Field Name",
      "type": "string",
      "example": "Example Name"
    },
    "Description": {
      "description": "Field Description",
      "type": "string",
      "example": "string"
    },
    "Behaviors": {
      "description": "Enable Metafield Behaviors",
      "type": "array",
      "items": {
        "enum": [
          "SendToOrder",
          "SendToMenu"
        ],
        "type": "string"
      },
      "example": [
        "SendToOrder"
      ]
    }
  }
}