---
title: "Update the format"
method: PATCH
path: "/formats/{format_id}"
tags: ["formats"]
---

# Update the format

`PATCH /formats/{format_id}`

settings with the given attributes

**Deprecated**: display_name
**Deprecated**: default_format

**Permission required:** edit_format_settings

## Headers

- `X-Fields` string, mask

## Request body

- FormatModelPatch
  - `display_name` string
  - `document_types` DocumentTypeModel[]
    - `display_name` string
    - `field_name` string, required
  - `labels` LabelModel[]
    - `category` 'annotation' | 'tag' | 'separator' | 'computed'
    - `count_in_evaluation` boolean — A flag that determines whether to count this field for evaluation
    - `description` string — A description of this field
    - `display_name` string
    - `field_name` string, required
    - `formula` string — An excel-like formula for conditional logic
    - `initialized` boolean
    - `is_library` boolean
    - `mandatory` boolean
    - `mandatory_if` object — A value to decide if mandatory based on other field
    - `multiple` boolean
    - `options` OptionModel[]
      - `active` boolean, required
      - `display_name` string
      - `name` string, required
    - `scope` 'document' | 'page' | 'section'
    - `type` 'string' | 'date' | 'integer' | 'float' | 'currency' | 'alphanumeric' | 'national_identification_number_be' | 'boolean' | 'datetime' | 'address'
    - `visible` boolean
    - `visible_if` object — A value to decide if shown in UI
  - `name` string
  - `separators` SectionModel[]
    - `name` string, required
    - `page` integer, required
  - `table_types` TableModel[]
    - `collapsed` boolean
    - `columns` LabelModel[]
      - `category` 'annotation' | 'tag' | 'separator' | 'computed'
      - `count_in_evaluation` boolean — A flag that determines whether to count this field for evaluation
      - `description` string — A description of this field
      - `display_name` string
      - `field_name` string, required
      - `formula` string — An excel-like formula for conditional logic
      - `initialized` boolean
      - `is_library` boolean
      - `mandatory` boolean
      - `mandatory_if` object — A value to decide if mandatory based on other field
      - `multiple` boolean
      - `options` OptionModel[]
        - `active` boolean, required
        - `display_name` string
        - `name` string, required
      - `scope` 'document' | 'page' | 'section'
      - `type` 'string' | 'date' | 'integer' | 'float' | 'currency' | 'alphanumeric' | 'national_identification_number_be' | 'boolean' | 'datetime' | 'address'
      - `visible` boolean
      - `visible_if` object — A value to decide if shown in UI
    - `contains_line_items` boolean
    - `initialized` boolean
    - `label` string
    - `scope` 'document' | 'page' | 'section'

## Response `200`

Success

- FormatModelGet
  - `document_types` DocumentTypeModel[]
    - `display_name` string
    - `field_name` string, required
  - `id` string, required
  - `labels` LabelModel[]
    - `category` 'annotation' | 'tag' | 'separator' | 'computed'
    - `count_in_evaluation` boolean — A flag that determines whether to count this field for evaluation
    - `description` string — A description of this field
    - `display_name` string
    - `field_name` string, required
    - `formula` string — An excel-like formula for conditional logic
    - `initialized` boolean
    - `is_library` boolean
    - `mandatory` boolean
    - `mandatory_if` object — A value to decide if mandatory based on other field
    - `multiple` boolean
    - `options` OptionModel[]
      - `active` boolean, required
      - `display_name` string
      - `name` string, required
    - `scope` 'document' | 'page' | 'section'
    - `type` 'string' | 'date' | 'integer' | 'float' | 'currency' | 'alphanumeric' | 'national_identification_number_be' | 'boolean' | 'datetime' | 'address'
    - `visible` boolean
    - `visible_if` object — A value to decide if shown in UI
  - `name` string
  - `separators` SectionModel[]
    - `name` string, required
    - `page` integer, required
  - `table_types` TableModel[]
    - `collapsed` boolean
    - `columns` LabelModel[]
      - `category` 'annotation' | 'tag' | 'separator' | 'computed'
      - `count_in_evaluation` boolean — A flag that determines whether to count this field for evaluation
      - `description` string — A description of this field
      - `display_name` string
      - `field_name` string, required
      - `formula` string — An excel-like formula for conditional logic
      - `initialized` boolean
      - `is_library` boolean
      - `mandatory` boolean
      - `mandatory_if` object — A value to decide if mandatory based on other field
      - `multiple` boolean
      - `options` OptionModel[]
        - `active` boolean, required
        - `display_name` string
        - `name` string, required
      - `scope` 'document' | 'page' | 'section'
      - `type` 'string' | 'date' | 'integer' | 'float' | 'currency' | 'alphanumeric' | 'national_identification_number_be' | 'boolean' | 'datetime' | 'address'
      - `visible` boolean
      - `visible_if` object — A value to decide if shown in UI
    - `contains_line_items` boolean
    - `initialized` boolean
    - `label` string
    - `scope` 'document' | 'page' | 'section'

## Other responses

- `403` — Permission insufficient

---

[API](https://skmtc.net/contractp/apis/contract-p.md) · [All operations](https://skmtc.net/contractp/apis/contract-p/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/contractp/contract-p/revisions/8ce53ebd6bd3/schema)