---
title: "Changes to PATCH /api/v1/document/documents/{id}/fields/"
method: PATCH
path: "/api/v1/document/documents/{id}/fields/"
---

# Changes to PATCH /api/v1/document/documents/{id}/fields/

`PATCH /api/v1/document/documents/{id}/fields/`

> Every recorded change to this operation, newest first.

## Timeline

Changed in 4 of 5 revisions.

- **2026-07-17** `3429f921b4cb`: 1 info
- **2021-09-22** `63116f2e9e3e`: 13 breaking, 3 warning, 14 info
- **2021-05-24** `8167164be9cc`: 22 breaking, 8 warning, 20 info
- **2020-12-11** `0957c4a7ae3d`: 22 breaking, 34 warning, 9 info

## Changes

- **2026-07-17** `3429f921b4cb`: 1 info
  - added the optional property `was_opened_in_annotator` to the response with the `200` status
- **2021-09-22** `63116f2e9e3e`: 13 breaking, 3 warning, 14 info
  - added the new required request property `created_by_initials` (media type: application/json)
  - added the new required request property `created_by_initials` (media type: application/x-www-form-urlencoded)
  - added the new required request property `created_by_initials` (media type: multipart/form-data)
  - added the new required request property `created_by_photo` (media type: application/json)
  - added the new required request property `created_by_photo` (media type: application/x-www-form-urlencoded)
  - added the new required request property `created_by_photo` (media type: multipart/form-data)
  - added the new required request property `modified_by_initials` (media type: application/json)
  - added the new required request property `modified_by_initials` (media type: application/x-www-form-urlencoded)
  - added the new required request property `modified_by_initials` (media type: multipart/form-data)
  - added the new required request property `modified_by_photo` (media type: application/json)
  - added the new required request property `modified_by_photo` (media type: application/x-www-form-urlencoded)
  - added the new required request property `modified_by_photo` (media type: multipart/form-data)
  - removed the required property `notes` from the response with the `200` status
  - removed the request property `notes` (media type: application/json)
  - removed the request property `notes` (media type: application/x-www-form-urlencoded)
  - removed the request property `notes` (media type: multipart/form-data)
  - added the new optional request property `assignee_data/initials` (media type: application/json)
  - added the new optional request property `assignee_data/initials` (media type: application/x-www-form-urlencoded)
  - added the new optional request property `assignee_data/initials` (media type: multipart/form-data)
  - added the new optional request property `available_assignees_data/items/initials` (media type: application/json)
  - added the new optional request property `available_assignees_data/items/initials` (media type: application/x-www-form-urlencoded)
  - added the new optional request property `available_assignees_data/items/initials` (media type: multipart/form-data)
  - added the optional property `assignee_data/initials` to the response with the `200` status
  - added the optional property `available_assignees_data/items/initials` to the response with the `200` status
  - added the optional property `documents_count` to the response with the `200` status
  - added the optional property `position` to the response with the `200` status
  - added the required property `created_by_initials` to the response with the `200` status
  - added the required property `created_by_photo` to the response with the `200` status
  - added the required property `modified_by_initials` to the response with the `200` status
  - added the required property `modified_by_photo` to the response with the `200` status
- **2021-05-24** `8167164be9cc`: 22 breaking, 8 warning, 20 info
  - added the new required request property `created_by_name` (media type: application/json)
  - added the new required request property `created_by_name` (media type: application/x-www-form-urlencoded)
  - added the new required request property `created_by_name` (media type: multipart/form-data)
  - added the new required request property `modified_by_name` (media type: application/json)
  - added the new required request property `modified_by_name` (media type: application/x-www-form-urlencoded)
  - added the new required request property `modified_by_name` (media type: multipart/form-data)
  - the request property `available_assignees_data` became required (media type: application/json)
  - the request property `available_assignees_data` became required (media type: application/x-www-form-urlencoded)
  - the request property `available_assignees_data` became required (media type: multipart/form-data)
  - the `available_assignees_data` request property type changed from `string` to `array` (media type: application/json)
  - the `available_assignees_data` request property type changed from `string` to `array` (media type: application/x-www-form-urlencoded)
  - the `available_assignees_data` request property type changed from `string` to `array` (media type: multipart/form-data)
  - the response property `available_assignees_data` became nullable for the status `200`
  - the `available_assignees_data` response's property type changed from `string` to `array` for status `200`
  - the `available_statuses_data` response's property type changed from `string` to `array` for status `200`
  - the `field_value_objects` response's property type changed from `string` to `object` for status `200`
  - the `field_values` response's property type changed from `string` to `object` for status `200`
  - the `next_id` response's property type changed from `string` to `integer` for status `200`
  - the `page_locations` response's property type changed from `string` to `array` for status `200`
  - the `prev_id` response's property type changed from `string` to `integer` for status `200`
  - the `sections` response's property type changed from `string` to `array` for status `200`
  - the `user_permissions` response's property type changed from `string` to `object` for status `200`
  - removed the request property `assignee_data/role` (media type: application/json)
  - removed the request property `assignee_data/role` (media type: application/x-www-form-urlencoded)
  - removed the request property `assignee_data/role` (media type: multipart/form-data)
  - removed the request property `notes/items/user/role` (media type: application/json)
  - removed the request property `notes/items/user/role` (media type: application/x-www-form-urlencoded)
  - removed the request property `notes/items/user/role` (media type: multipart/form-data)
  - removed the optional property `assignee_data/role` from the response with the `200` status
  - removed the optional property `notes/items/user/role` from the response with the `200` status
  - added the new optional request property `created_date` (media type: application/json)
  - added the new optional request property `created_date` (media type: application/x-www-form-urlencoded)
  - added the new optional request property `created_date` (media type: multipart/form-data)
  - added the new optional request property `modified_date` (media type: application/json)
  - added the new optional request property `modified_date` (media type: application/x-www-form-urlencoded)
  - added the new optional request property `modified_date` (media type: multipart/form-data)
  - the request optional property `available_assignees_data` became not read-only (media type: application/json)
  - the request optional property `available_assignees_data` became not read-only (media type: application/x-www-form-urlencoded)
  - the request optional property `available_assignees_data` became not read-only (media type: multipart/form-data)
  - the request property `available_assignees_data` became nullable (media type: application/json)
  - …10 more
- **2020-12-11** `0957c4a7ae3d`: 22 breaking, 34 warning, 9 info
  - added the new required request property `notes` (media type: application/json)
  - added the new required request property `notes` (media type: application/x-www-form-urlencoded)
  - added the new required request property `notes` (media type: multipart/form-data)
  - the request property `available_assignees_data` became not nullable (media type: application/json)
  - the request property `available_assignees_data` became not nullable (media type: application/x-www-form-urlencoded)
  - the request property `available_assignees_data` became not nullable (media type: multipart/form-data)
  - the response property `available_assignees_data` became optional for the status `200`
  - the `available_assignees_data` response's property type changed from `array` to `string` for status `200`
  - the `available_statuses_data` response's property type changed from `array` to `string` for status `200`
  - the `field_value_objects` response's property type changed from `object` to `string` for status `200`
  - the `field_values` response's property type changed from `object` to `string` for status `200`
  - the `next_id` response's property type changed from `integer` to `string` for status `200`
  - the `page_locations` response's property type changed from `array` to `string` for status `200`
  - the `prev_id` response's property type changed from `integer` to `string` for status `200`
  - the `sections` response's property type changed from `array` to `string` for status `200`
  - the `user_permissions` response's property type changed from `object` to `string` for status `200`
  - removed the required property `created_by_initials` from the response with the `200` status
  - removed the required property `created_by_name` from the response with the `200` status
  - removed the required property `created_by_photo` from the response with the `200` status
  - removed the required property `modified_by_initials` from the response with the `200` status
  - removed the required property `modified_by_name` from the response with the `200` status
  - removed the required property `modified_by_photo` from the response with the `200` status
  - removed the request property `assignee_data/initials` (media type: application/json)
  - removed the request property `assignee_data/initials` (media type: application/x-www-form-urlencoded)
  - removed the request property `assignee_data/initials` (media type: multipart/form-data)
  - removed the request property `created_by_initials` (media type: application/json)
  - removed the request property `created_by_initials` (media type: application/x-www-form-urlencoded)
  - removed the request property `created_by_initials` (media type: multipart/form-data)
  - removed the request property `created_by_name` (media type: application/json)
  - removed the request property `created_by_name` (media type: application/x-www-form-urlencoded)
  - removed the request property `created_by_name` (media type: multipart/form-data)
  - removed the request property `created_by_photo` (media type: application/json)
  - removed the request property `created_by_photo` (media type: application/x-www-form-urlencoded)
  - removed the request property `created_by_photo` (media type: multipart/form-data)
  - removed the request property `created_date` (media type: application/json)
  - removed the request property `created_date` (media type: application/x-www-form-urlencoded)
  - removed the request property `created_date` (media type: multipart/form-data)
  - removed the request property `modified_by_initials` (media type: application/json)
  - removed the request property `modified_by_initials` (media type: application/x-www-form-urlencoded)
  - removed the request property `modified_by_initials` (media type: multipart/form-data)
  - …25 more

---

[Operation](https://skmtc.dev/lexpredict/apis/contraxsuite-api/docs/api/v1/document/documents/:id/fields/patch.md) - [API](https://skmtc.dev/lexpredict/apis/contraxsuite-api.md) - [Page](https://skmtc.dev/lexpredict/apis/contraxsuite-api/changes/api/v1/document/documents/:id/fields/patch)