v1

latestOpenAPI 3.0.02026-07-14135106116.2 KB

formats

Update the format

settings with the given attributes

Deprecated: display_name Deprecated: default_format

Permission required: edit_format_settings

patch/formats/{format_id}

Headers

X-Fieldsstring mask

An optional fields mask

Request body

display_namestring

namestring

Example request

{
  "labels": [
    {
      "category": "annotation",
      "scope": "section",
      "type": "string"
    }
  ],
  "table_types": [
    {
      "columns": [
        {
          "category": "annotation",
          "scope": "section",
          "type": "string"
        }
      ],
      "scope": "section"
    }
  ]
}

Response

Success

idstring required

namestring

Example response

{
  "labels": [
    {
      "category": "annotation",
      "scope": "section",
      "type": "string"
    }
  ],
  "table_types": [
    {
      "columns": [
        {
          "category": "annotation",
          "scope": "section",
          "type": "string"
        }
      ],
      "scope": "section"
    }
  ]
}