Actions22
- Organizations › List Workspaces
- Previews › List
- Projects › Archive
- Projects › Chat With Project
- Projects › Clone
- Projects › Create
- Projects › Delete
- Projects › Get
- Projects › List
- Projects › Research With Project
- Projects › Unarchive
- Projects › Update
- Signature Assignments › Create
- Signature Assignments › Delete
- Signature Assignments › List
- Signature Assignments › Update Row
- Templates › Archive
- Templates › Delete
- Templates › Get
- Templates › List
- Templates › Unarchive
- Templates › Update Metadata
Projects › Update
AI-generatedSummary
Update a Ghostsign proposal (project) with optional variable values, notes, display name, and executed PDF CC data.
Inputs
- projectId (required) — Proposal UUID obtained from
projects.list; identifies the project to update. - suppressVariableValuesPatch — If true, omits sending
variable_valuesso CC recipients, renaming, or notes can update without a placeholder JSON payload. - variableValuesJson — JSON object keyed by template variable identifiers to update variable values; leave blank to skip.
- setContextNotes — When true, includes additional notes; enable to use
contextNotesBody. - contextNotesBody — Body text for context notes; required when
setContextNotesis true. - executedPdfCcJson — JSON array or object listing mailbox recipients for completed proposal PDFs; may be omitted.
- projectDisplayName — New display name to rename the proposal; used alone or with other updates.
Output shape
A single record representing the updated project returned by the Ghostsign API.
The response includes the updated project object; if required fields are missing, an error is thrown. Use
suppressVariableValuesPatchto omit variable values.
Examples
Example 1: Rename a proposal and add context notes.
Set projectId to the proposal UUID, enable setContextNotes, provide contextNotesBody, and optionally set projectDisplayName.
Example 2: Update variable values and CC list for a completed proposal.
Provide projectId, fill variableValuesJson, optionally set executedPdfCcJson, and leave suppressVariableValuesPatch false to send the values.