Ghostsign icon

Ghostsign

Call Ghostsign unified `ghostsign-api` (orgs, templates, projects, previews, signer rows)

Signature Assignments › Create

AI-generated

Summary

Create a signature assignment for a Ghostsign project.

Inputs

  • projectId (required) — UUID of the Ghostsign project (proposal) to assign the signature to.
  • assignmentVariableKey (required) — Ghostsign template variable key that maps the signer field.
  • signerEmail (required) — Email address of the signer.
  • signerName (required) — Display name of the signer used in email communications.
  • assignmentFieldType — Type of field to sign; one of date, initial, signature, text.
  • assignmentRequired — Whether the field is required before signing.
  • assignmentSortOrder — Numerical order of the field among other assignments.
  • overlayRectJson — Optional JSON describing overlay rectangle metadata for the signer.

Output shape

a single created signature assignment object

The response contains the newly created assignment details; fields include assignment UUID and persisted overlay_rect if provided. No pagination.

Examples

Example 1: Add a required text field for client signature on a proposal.

Set Project to proposal UUID, Template Variable Key to 'clientSignature', Signer Email to 'client@example.com', Signer Name to 'Client Name', Field Type to 'Text', Required to true, and optionally provide Overlay Rect JSON.

Example 2: Create an initial signature assignment for a project.

Configure Project, Template Variable Key='initialSignature', Signer Email='john@example.com', Signer Name='John Doe', Field Type='Initial', Required=true.

Example 3: Create an assignment with custom overlay rectangle for PDF placement.

Set Project, Template Variable Key='customOverlayKey', Signer Email='artist@example.com', Signer Name='Artist Name', Overlay Rect JSON='{"x":100,"y":200,"width":300,"height":150}'.

Links

Discussion