---
title: "PATCH /api/v1/document/project/{project_pk}/documents/{id}/fields/"
method: PATCH
path: "/api/v1/document/project/{project_pk}/documents/{id}/fields/"
tags: ["document", "v1"]
---

# PATCH /api/v1/document/project/{project_pk}/documents/{id}/fields/

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

## Path parameters

- `project_pk` string, required
- `id` string, required

## Request body

- DocumentDetail
  - `pk` integer
  - `name` string, nullable
  - `document_type` string, nullable
  - `file_size` integer
  - `folder` string, nullable
  - `created_date` string, date-time, nullable
  - `modified_date` string, date-time, nullable
  - `modified_by_name` string, required
  - `created_by_name` string, required
  - `created_by_initials` string, required
  - `created_by_photo` string, required
  - `modified_by_initials` string, required
  - `modified_by_photo` string, required
  - `status` integer, nullable
  - `status_data` DocumentDetailStatusData, required
    - `id` integer
    - `name` string, required
    - `code` string, nullable
    - `order` integer, required
    - `is_active` boolean
    - `group` integer, nullable
  - `available_statuses_data` object[]
  - `assignee` integer, nullable
  - `assign_date` string, date-time, nullable
  - `assignee_data` DocumentDetailAssigneeData, nullable, required
    - `pk` integer
    - `first_name` string
    - `last_name` string
    - `username` string, required — Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.
    - `photo` string
    - `name` string
    - `initials` string
  - `available_assignees_data` DocumentDetailAvailableAssigneesDataInner[], nullable, required
    - `pk` integer
    - `first_name` string
    - `last_name` string
    - `username` string, required — Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.
    - `photo` string
    - `name` string
    - `initials` string
  - `description` string, nullable
  - `title` string, nullable
  - `initial_annotation_id` string
  - `page_locations` array[]
    - integer[]
  - `page_bounds` array[]
    - number[]
  - `field_values` object
  - `field_value_objects` object
  - `prev_id` integer
  - `next_id` integer
  - `position` string
  - `documents_count` string
  - `sections` object[]
  - `cluster_id` string
  - `was_opened_in_annotator` boolean
  - `user_permissions` object

## Response `200`

- DocumentDetail
  - `pk` integer
  - `name` string, nullable
  - `document_type` string, nullable
  - `file_size` integer
  - `folder` string, nullable
  - `created_date` string, date-time, nullable
  - `modified_date` string, date-time, nullable
  - `modified_by_name` string, required
  - `created_by_name` string, required
  - `created_by_initials` string, required
  - `created_by_photo` string, required
  - `modified_by_initials` string, required
  - `modified_by_photo` string, required
  - `status` integer, nullable
  - `status_data` DocumentDetailStatusData, required
    - `id` integer
    - `name` string, required
    - `code` string, nullable
    - `order` integer, required
    - `is_active` boolean
    - `group` integer, nullable
  - `available_statuses_data` object[]
  - `assignee` integer, nullable
  - `assign_date` string, date-time, nullable
  - `assignee_data` DocumentDetailAssigneeData, nullable, required
    - `pk` integer
    - `first_name` string
    - `last_name` string
    - `username` string, required — Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.
    - `photo` string
    - `name` string
    - `initials` string
  - `available_assignees_data` DocumentDetailAvailableAssigneesDataInner[], nullable, required
    - `pk` integer
    - `first_name` string
    - `last_name` string
    - `username` string, required — Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.
    - `photo` string
    - `name` string
    - `initials` string
  - `description` string, nullable
  - `title` string, nullable
  - `initial_annotation_id` string
  - `page_locations` array[]
    - integer[]
  - `page_bounds` array[]
    - number[]
  - `field_values` object
  - `field_value_objects` object
  - `prev_id` integer
  - `next_id` integer
  - `position` string
  - `documents_count` string
  - `sections` object[]
  - `cluster_id` string
  - `was_opened_in_annotator` boolean
  - `user_permissions` object

## Changes

> 5 revisions in range; 1 could not be searched.

- **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)
  - …26 more
- **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)
  - …46 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)
  - …61 more

[Change history](https://skmtc.dev/lexpredict/apis/contraxsuite-api/changes/api/v1/document/project/:project_pk/documents/:id/fields/patch.md)

---

[API](https://skmtc.dev/lexpredict/apis/contraxsuite-api.md) · [All operations](https://skmtc.dev/lexpredict/apis/contraxsuite-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/lexpredict/contraxsuite-api/revisions/3429f921b4cb/schema)