GhostsignInstall

Summary

Update an existing signature assignment row with patches to its fields.

Inputs

• assignmentId (required) — UUID of the assignment row to update, obtained from signature_assignments.create or signature_assignments.list.
• assignmentVariableKeyPatch — Patch value for the template variable key (full row snapshot).
• signerEmailPatch — Patch value for the signer's email.
• signerNamePatch — Patch value for the signer's name.
• assignmentFieldTypePatch — Patch value for field type, one of date, initial, signature, text.
• assignmentRequiredPatch — Patch boolean indicating if the field is required.
• assignmentSortOrderPatch — Patch number for sort order.
• clearOverlayRect — Whether to clear the overlay_rect field on this assignment.
• overlayRectJsonPatch — Optional overlay metadata JSON for PDF placement (ignored if clearOverlayRect true).

Output shape

single assignment record (JSON)

Returns the updated assignment object as sent by the Ghostsign API; may include fields like assignment_id, field_type, required, overlay_rect, etc. No pagination; on error an exception is raised.

Examples

Example 1: Update the signer email and field type of an assignment

Set operation to "signature_assignments.update", fill assignmentId with the target UUID, provide signerEmailPatch with the new email and assignmentFieldTypePatch with "text" (or another allowed value).

Example 2: Clear the overlay rectangle for an assignment

Set operation to "signature_assignments.update", provide assignmentId, set clearOverlayRect to true, and optionally supply overlayRectJsonPatch if you wish to retain custom overlay data.

Links

• n8n community nodes installation guide