Sign in

v1

latestOpenAPI 3.0.0proprietary2026-07-261695971.5 MB
Field

Update a Field

Updates a given Field. Any parameters not provided are left unchanged.

patch/signature_requests/{signatureRequestId}/documents/{documentId}/fields/{fieldId}

Path parameters

signatureRequestIdstring uuid required

The unique identifier for a resource.

Example:9a93d3b5-fb3b-4abf-9e70-26315b33506c

Signature Request Id

documentIdstring uuid required

The unique identifier for a resource.

Example:9a93d3b5-fb3b-4abf-9e70-26315b33506c

Document Id

fieldIdstring uuid required

The unique identifier for a resource.

Example:9a93d3b5-fb3b-4abf-9e70-26315b33506c

Field Id

Request body

OR
OR
OR
OR
OR
OR

Example request

{
  "signer_id": "9b6ed2f3-244f-487a-baa1-bbe4f51c8748",
  "page": 1,
  "x": 400,
  "y": 400,
  "height": 50,
  "width": 200,
  "display": {
    "layout": "detailed",
    "options": {
      "date_format": "dd/MM/yyyy",
      "time_format": "HH:mm",
      "show_timezone": true,
      "show_email": false
    }
  }
}

Response

The Field has been successfully updated.

OR
OR
OR
OR
OR
OR
OR
OR

Example response

{
  "id": "9b6ed2f3-244f-487a-baa1-bbe4f51c8748",
  "document_id": "9b6ed2f3-244f-487a-baa1-bbe4f51c8748",
  "signer_id": "9b6ed2f3-244f-487a-baa1-bbe4f51c8748",
  "display": {
    "options": {
      "date_format": "dd/MM/yyyy",
      "time_format": "HH:mm"
    }
  }
}