Update a field for a document

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

patch/api/v1/documents/{id}/fields/{fieldId}

Request

  • Base URL: https://docs.thecareoasis.com
  • URL: https://docs.thecareoasis.com/api/v1/documents/{id}/fields/{fieldId}
  • Auth: API key in header Authorization

Path parameters

idstring required
fieldIdstring required

Headers

authorizationstring required

Request body

recipientIdnumber
type'SIGNATURE' | 'FREE_SIGNATURE' | 'INITIALS' | 'NAME' | 'EMAIL' | 'DATE' | 'TEXT' | 'NUMBER' | 'RADIO' | 'CHECKBOX' | 'DROPDOWN'
pageNumbernumber
pageXnumber
pageYnumber
pageWidthnumber
pageHeightnumber

Response

200

idnumber required
documentIdnumber required
recipientIdnumber required
type'SIGNATURE' | 'FREE_SIGNATURE' | 'INITIALS' | 'NAME' | 'EMAIL' | 'DATE' | 'TEXT' | 'NUMBER' | 'RADIO' | 'CHECKBOX' | 'DROPDOWN' required
pageNumbernumber required
pageXnumber required
pageYnumber required
pageWidthnumber required
pageHeightnumber required
customTextstring required
insertedboolean required

Changes

No recorded changes to this operation across all 1 revision of this API.