---
title: "Create a field for a document"
method: POST
path: "/api/v1/documents/{id}/fields"
deprecated: true
---

# Create a field for a document

`POST /api/v1/documents/{id}/fields`

> **Deprecated.**

This endpoint is deprecated, but will continue to be supported. For more details, see https://docs.documenso.com/developers/public-api.

## Path parameters

- `id` string, required

## Headers

- `authorization` string, required

## Request body

- union
  - object
    - `recipientId` number, required
    - `type` 'SIGNATURE' | 'FREE_SIGNATURE' | 'INITIALS' | 'NAME' | 'EMAIL' | 'DATE' | 'TEXT' | 'NUMBER' | 'RADIO' | 'CHECKBOX' | 'DROPDOWN', required
    - `pageNumber` number, required
    - `pageX` number, required
    - `pageY` number, required
    - `pageWidth` number, required
    - `pageHeight` number, required
    - `fieldMeta` union
      - object
      - object
        - `label` string
        - `placeholder` string
        - `required` boolean
        - `readOnly` boolean
        - `fontSize` number
        - `type` 'signature', required
      - object
        - `label` string
        - `placeholder` string
        - `required` boolean
        - `readOnly` boolean
        - `fontSize` number
        - `type` 'initials', required
        - `textAlign` 'left' | 'center' | 'right'
      - object
        - `label` string
        - `placeholder` string
        - `required` boolean
        - `readOnly` boolean
        - `fontSize` number
        - `type` 'name', required
        - `textAlign` 'left' | 'center' | 'right'
      - object
        - `label` string
        - `placeholder` string
        - `required` boolean
        - `readOnly` boolean
        - `fontSize` number
        - `type` 'email', required
        - `textAlign` 'left' | 'center' | 'right'
      - object
        - `label` string
        - `placeholder` string
        - `required` boolean
        - `readOnly` boolean
        - `fontSize` number
        - `type` 'date', required
        - `textAlign` 'left' | 'center' | 'right'
      - object
        - `label` string
        - `placeholder` string
        - `required` boolean
        - `readOnly` boolean
        - `fontSize` number
        - `type` 'text', required
        - `text` string
        - `characterLimit` number, nullable
        - `textAlign` 'left' | 'center' | 'right'
        - `lineHeight` number, nullable — The line height of the text
        - `letterSpacing` number, nullable — The spacing between each character
        - `verticalAlign` 'top' | 'middle' | 'bottom', nullable — The vertical alignment of the text
      - object
        - `label` string
        - `placeholder` string
        - `required` boolean
        - `readOnly` boolean
        - `fontSize` number
        - `type` 'number', required
        - `numberFormat` string, nullable
        - `value` string
        - `minValue` number, nullable
        - `maxValue` number, nullable
        - `textAlign` 'left' | 'center' | 'right'
        - `lineHeight` number, nullable — The line height of the text
        - `letterSpacing` number, nullable — The spacing between each character
        - `verticalAlign` 'top' | 'middle' | 'bottom', nullable — The vertical alignment of the text
      - object
        - `label` string
        - `placeholder` string
        - `required` boolean
        - `readOnly` boolean
        - `fontSize` number
        - `type` 'radio', required
        - `values` object[]
          - `id` number, required
          - `checked` boolean, required
          - `value` string, required
        - `direction` 'vertical' | 'horizontal'
      - object
        - `label` string
        - `placeholder` string
        - `required` boolean
        - `readOnly` boolean
        - `fontSize` number
        - `type` 'checkbox', required
        - `values` object[]
          - `id` number, required
          - `checked` boolean, required
          - `value` string, required
        - `validationRule` string
        - `validationLength` number
        - `direction` 'vertical' | 'horizontal'
      - object
        - `label` string
        - `placeholder` string
        - `required` boolean
        - `readOnly` boolean
        - `fontSize` number
        - `type` 'dropdown', required
        - `values` object[]
          - `value` string, required
        - `defaultValue` string
  - object[]
    - `recipientId` number, required
    - `type` 'SIGNATURE' | 'FREE_SIGNATURE' | 'INITIALS' | 'NAME' | 'EMAIL' | 'DATE' | 'TEXT' | 'NUMBER' | 'RADIO' | 'CHECKBOX' | 'DROPDOWN', required
    - `pageNumber` number, required
    - `pageX` number, required
    - `pageY` number, required
    - `pageWidth` number, required
    - `pageHeight` number, required
    - `fieldMeta` union
      - object
      - object
        - `label` string
        - `placeholder` string
        - `required` boolean
        - `readOnly` boolean
        - `fontSize` number
        - `type` 'signature', required
      - object
        - `label` string
        - `placeholder` string
        - `required` boolean
        - `readOnly` boolean
        - `fontSize` number
        - `type` 'initials', required
        - `textAlign` 'left' | 'center' | 'right'
      - object
        - `label` string
        - `placeholder` string
        - `required` boolean
        - `readOnly` boolean
        - `fontSize` number
        - `type` 'name', required
        - `textAlign` 'left' | 'center' | 'right'
      - object
        - `label` string
        - `placeholder` string
        - `required` boolean
        - `readOnly` boolean
        - `fontSize` number
        - `type` 'email', required
        - `textAlign` 'left' | 'center' | 'right'
      - object
        - `label` string
        - `placeholder` string
        - `required` boolean
        - `readOnly` boolean
        - `fontSize` number
        - `type` 'date', required
        - `textAlign` 'left' | 'center' | 'right'
      - object
        - `label` string
        - `placeholder` string
        - `required` boolean
        - `readOnly` boolean
        - `fontSize` number
        - `type` 'text', required
        - `text` string
        - `characterLimit` number, nullable
        - `textAlign` 'left' | 'center' | 'right'
        - `lineHeight` number, nullable — The line height of the text
        - `letterSpacing` number, nullable — The spacing between each character
        - `verticalAlign` 'top' | 'middle' | 'bottom', nullable — The vertical alignment of the text
      - object
        - `label` string
        - `placeholder` string
        - `required` boolean
        - `readOnly` boolean
        - `fontSize` number
        - `type` 'number', required
        - `numberFormat` string, nullable
        - `value` string
        - `minValue` number, nullable
        - `maxValue` number, nullable
        - `textAlign` 'left' | 'center' | 'right'
        - `lineHeight` number, nullable — The line height of the text
        - `letterSpacing` number, nullable — The spacing between each character
        - `verticalAlign` 'top' | 'middle' | 'bottom', nullable — The vertical alignment of the text
      - object
        - `label` string
        - `placeholder` string
        - `required` boolean
        - `readOnly` boolean
        - `fontSize` number
        - `type` 'radio', required
        - `values` object[]
          - `id` number, required
          - `checked` boolean, required
          - `value` string, required
        - `direction` 'vertical' | 'horizontal'
      - object
        - `label` string
        - `placeholder` string
        - `required` boolean
        - `readOnly` boolean
        - `fontSize` number
        - `type` 'checkbox', required
        - `values` object[]
          - `id` number, required
          - `checked` boolean, required
          - `value` string, required
        - `validationRule` string
        - `validationLength` number
        - `direction` 'vertical' | 'horizontal'
      - object
        - `label` string
        - `placeholder` string
        - `required` boolean
        - `readOnly` boolean
        - `fontSize` number
        - `type` 'dropdown', required
        - `values` object[]
          - `value` string, required
        - `defaultValue` string

## Response `200`

200

- object
  - `fields` union, required
    - object
      - `id` number, required
      - `documentId` number, required
      - `recipientId` number, required
      - `type` 'SIGNATURE' | 'FREE_SIGNATURE' | 'INITIALS' | 'NAME' | 'EMAIL' | 'DATE' | 'TEXT' | 'NUMBER' | 'RADIO' | 'CHECKBOX' | 'DROPDOWN', required
      - `pageNumber` number, required
      - `pageX` number, required
      - `pageY` number, required
      - `pageWidth` number, required
      - `pageHeight` number, required
      - `customText` string, required
      - `fieldMeta` union
        - object
        - object
          - `label` string
          - `placeholder` string
          - `required` boolean
          - `readOnly` boolean
          - `fontSize` number
          - `type` 'signature', required
        - object
          - `label` string
          - `placeholder` string
          - `required` boolean
          - `readOnly` boolean
          - `fontSize` number
          - `type` 'initials', required
          - `textAlign` 'left' | 'center' | 'right'
        - object
          - `label` string
          - `placeholder` string
          - `required` boolean
          - `readOnly` boolean
          - `fontSize` number
          - `type` 'name', required
          - `textAlign` 'left' | 'center' | 'right'
        - object
          - `label` string
          - `placeholder` string
          - `required` boolean
          - `readOnly` boolean
          - `fontSize` number
          - `type` 'email', required
          - `textAlign` 'left' | 'center' | 'right'
        - object
          - `label` string
          - `placeholder` string
          - `required` boolean
          - `readOnly` boolean
          - `fontSize` number
          - `type` 'date', required
          - `textAlign` 'left' | 'center' | 'right'
        - object
          - `label` string
          - `placeholder` string
          - `required` boolean
          - `readOnly` boolean
          - `fontSize` number
          - `type` 'text', required
          - `text` string
          - `characterLimit` number, nullable
          - `textAlign` 'left' | 'center' | 'right'
          - `lineHeight` number, nullable — The line height of the text
          - `letterSpacing` number, nullable — The spacing between each character
          - `verticalAlign` 'top' | 'middle' | 'bottom', nullable — The vertical alignment of the text
        - object
          - `label` string
          - `placeholder` string
          - `required` boolean
          - `readOnly` boolean
          - `fontSize` number
          - `type` 'number', required
          - `numberFormat` string, nullable
          - `value` string
          - `minValue` number, nullable
          - `maxValue` number, nullable
          - `textAlign` 'left' | 'center' | 'right'
          - `lineHeight` number, nullable — The line height of the text
          - `letterSpacing` number, nullable — The spacing between each character
          - `verticalAlign` 'top' | 'middle' | 'bottom', nullable — The vertical alignment of the text
        - object
          - `label` string
          - `placeholder` string
          - `required` boolean
          - `readOnly` boolean
          - `fontSize` number
          - `type` 'radio', required
          - `values` object[]
            - `id` number, required
            - `checked` boolean, required
            - `value` string, required
          - `direction` 'vertical' | 'horizontal'
        - object
          - `label` string
          - `placeholder` string
          - `required` boolean
          - `readOnly` boolean
          - `fontSize` number
          - `type` 'checkbox', required
          - `values` object[]
            - `id` number, required
            - `checked` boolean, required
            - `value` string, required
          - `validationRule` string
          - `validationLength` number
          - `direction` 'vertical' | 'horizontal'
        - object
          - `label` string
          - `placeholder` string
          - `required` boolean
          - `readOnly` boolean
          - `fontSize` number
          - `type` 'dropdown', required
          - `values` object[]
            - `value` string, required
          - `defaultValue` string
      - `inserted` boolean, required
    - object[]
      - `id` number, required
      - `documentId` number, required
      - `recipientId` number, required
      - `type` 'SIGNATURE' | 'FREE_SIGNATURE' | 'INITIALS' | 'NAME' | 'EMAIL' | 'DATE' | 'TEXT' | 'NUMBER' | 'RADIO' | 'CHECKBOX' | 'DROPDOWN', required
      - `pageNumber` number, required
      - `pageX` number, required
      - `pageY` number, required
      - `pageWidth` number, required
      - `pageHeight` number, required
      - `customText` string, required
      - `fieldMeta` union
        - object
        - object
          - `label` string
          - `placeholder` string
          - `required` boolean
          - `readOnly` boolean
          - `fontSize` number
          - `type` 'signature', required
        - object
          - `label` string
          - `placeholder` string
          - `required` boolean
          - `readOnly` boolean
          - `fontSize` number
          - `type` 'initials', required
          - `textAlign` 'left' | 'center' | 'right'
        - object
          - `label` string
          - `placeholder` string
          - `required` boolean
          - `readOnly` boolean
          - `fontSize` number
          - `type` 'name', required
          - `textAlign` 'left' | 'center' | 'right'
        - object
          - `label` string
          - `placeholder` string
          - `required` boolean
          - `readOnly` boolean
          - `fontSize` number
          - `type` 'email', required
          - `textAlign` 'left' | 'center' | 'right'
        - object
          - `label` string
          - `placeholder` string
          - `required` boolean
          - `readOnly` boolean
          - `fontSize` number
          - `type` 'date', required
          - `textAlign` 'left' | 'center' | 'right'
        - object
          - `label` string
          - `placeholder` string
          - `required` boolean
          - `readOnly` boolean
          - `fontSize` number
          - `type` 'text', required
          - `text` string
          - `characterLimit` number, nullable
          - `textAlign` 'left' | 'center' | 'right'
          - `lineHeight` number, nullable — The line height of the text
          - `letterSpacing` number, nullable — The spacing between each character
          - `verticalAlign` 'top' | 'middle' | 'bottom', nullable — The vertical alignment of the text
        - object
          - `label` string
          - `placeholder` string
          - `required` boolean
          - `readOnly` boolean
          - `fontSize` number
          - `type` 'number', required
          - `numberFormat` string, nullable
          - `value` string
          - `minValue` number, nullable
          - `maxValue` number, nullable
          - `textAlign` 'left' | 'center' | 'right'
          - `lineHeight` number, nullable — The line height of the text
          - `letterSpacing` number, nullable — The spacing between each character
          - `verticalAlign` 'top' | 'middle' | 'bottom', nullable — The vertical alignment of the text
        - object
          - `label` string
          - `placeholder` string
          - `required` boolean
          - `readOnly` boolean
          - `fontSize` number
          - `type` 'radio', required
          - `values` object[]
            - `id` number, required
            - `checked` boolean, required
            - `value` string, required
          - `direction` 'vertical' | 'horizontal'
        - object
          - `label` string
          - `placeholder` string
          - `required` boolean
          - `readOnly` boolean
          - `fontSize` number
          - `type` 'checkbox', required
          - `values` object[]
            - `id` number, required
            - `checked` boolean, required
            - `value` string, required
          - `validationRule` string
          - `validationLength` number
          - `direction` 'vertical' | 'horizontal'
        - object
          - `label` string
          - `placeholder` string
          - `required` boolean
          - `readOnly` boolean
          - `fontSize` number
          - `type` 'dropdown', required
          - `values` object[]
            - `value` string, required
          - `defaultValue` string
      - `inserted` boolean, required
  - `documentId` number, required

## Other responses

- `400` — 400
- `401` — 401
- `404` — 404
- `500` — 500

---

[API](https://skmtc.dev/kpitaljobs/apis/documenso-api.md) · [All operations](https://skmtc.dev/kpitaljobs/apis/documenso-api/llms.txt) · [OpenAPI document](https://skmtc.dev/kpitaljobs/apis/documenso-api/revisions/fafcd949413a?raw)