Actions16
- Document Actions
- Template Actions
- Recipient Actions
- Field Actions
Recipient → Update Recipient
AI-generatedSummary
Updates a recipient on a document in SpaceSign via PATCH /documents/{documentId}/recipients/{recipientId}.
Inputs
- documentId (required) — Identifier of the document containing the recipient to update.
- recipientId (required) — Identifier of the recipient to update.
- recipientData — Collection of fields to update. Supported: email (string), name (string), role (options: APPROVER, ASSISTANT, CC, SIGNER, VIEWER), signingOrder (number), externalId (string), meta (JSON), authOptions (JSON). If omitted, no fields are changed.
Output shape
The SpaceSign API response containing the updated recipient object.
Returned as a single JSON item on the main output.
Examples
Example 1: Update a recipient's email and role.
Set documentId to the target document's ID, recipientId to the recipient's ID, and recipientData to { email: 'new@email.com', role: 'SIGNER' }.