ProposalyInstall

Summary

Updates a recipient in a document via the Proposaly API. Only non-empty optional fields are included in the request body.

Inputs

• recipientId (required) — Recipient Name or ID, loaded from the document's recipient list. Can be selected from the list or specified via expression.
• workspaceId (required) — Workspace Name or ID, loaded from available workspaces. Required to scope the recipient document context.
• documentId (required) — Document Name or ID, loaded from the workspace. Required to populate recipient choices; depends on workspaceId.
• firstNameOptional — First name of the recipient. Only sent to the API if non-empty.
• lastNameOptional — Last name of the recipient. Only sent to the API if non-empty.
• emailOptional — Email address of the recipient. Only sent to the API if non-empty. Placeholder: name@example.com.
• phoneNumberOptional — Phone number of the recipient. Only sent to the API if non-empty. Placeholder: +1234567890.
• accessLevelOptional — Access level of the recipient. Options: No Change (empty), Editor, Viewer. Only sent if non-empty.
• statusOptional — Status of the recipient. Options: No Change (empty), Active, Block. Only sent if non-empty.

Output shape

The Proposaly API response body as JSON, paired with the workflow item that triggered the operation.

Returned data is the updated recipient object from the API. Paired item preserves the input item index.

Examples

Example 1: Update recipient name and access level

Select a recipient from the document's recipient list, set First Name and/or Last Name optionally, choose Access Level (Editor or Viewer), and the operation will PUT the changes to the Proposaly API.

Links

• n8n community nodes installation guide