SpaceSign

Interact with the SpaceSign API

Actions16

Field → Update Field

AI-generated

Summary

Updates a field within a SpaceSign document via PATCH /api/v1/documents/:documentId/fields/:fieldId.

Inputs

  • documentId (required) — The ID of the document containing the field to update.
  • fieldId (required) — The ID of the field to update.
  • fieldUpdateData — Data specifying the field update. Optional fields not set to default values are sent in the request body. Includes fieldMetaJson, pageHeight, pageNumber, pageX, pageY, type, pageWidth.

Output shape

object

The updated field resource returned by the SpaceSign API.

Examples

Example 1: Update a field's type and position on page 1 of a document.

Set documentId to the target document's ID, fieldId to the target field's ID, and fieldUpdateData.type to 'TEXT', fieldUpdateData.pageX to 10, fieldUpdateData.pageY to 20.

Discussion