DocuSeal icon

DocuSeal

Create documents, manage templates, and handle submissions with DocuSeal

Actions23

Overview

This node allows you to update information about a submitter in the DocuSeal system. A submitter typically represents a person involved in document signing or submission workflows. The update operation lets you modify various attributes of a submitter, such as their contact details, role, completion status, notification preferences, and custom field configurations.

Common scenarios where this node is useful include:

  • Changing a submitter’s email or phone number after initial creation.
  • Marking a submitter as completed to reflect workflow progress.
  • Customizing notification settings by enabling or disabling email or SMS alerts.
  • Updating field values or making fields read-only or required for the submitter.
  • Sending customized messages (email subject and body) to the submitter.

Practical example:
You have a document signing process with multiple submitters. One submitter changes their phone number, and you want to update it in the system and send them an SMS notification about the change. This node can perform that update and trigger the notification in one step.

Properties

Name Meaning
Submitter ID The unique numeric identifier of the submitter to update.
Update Fields Collection of fields to update on the submitter:
• Completed: Mark the submitter as completed (boolean).
• Completed Redirect URL: URL to redirect after completion.
• Email: Update email address.
• External ID: Update external identifier.
• Message: Custom email message with Subject and Body.
• Name: Update submitter name.
• Phone: Update phone number.
• Role: Update submitter role (e.g., Signer, Client, Witness).
• Send Email: Whether to send an email notification (boolean).
• Send SMS: Whether to send an SMS notification (boolean).
Fields Configuration Configure individual field settings for the submitter (multiple entries allowed):
• Field Name: Name of the field as defined in the template.
• Default Value: Default value for the field.
• Read Only: Whether the field is read-only (boolean).
• Required: Whether the field is required (boolean).
Field Values Pre-fill field values for the submitter (multiple entries allowed):
• Field Name: Name of the field.
• Value: Value to set for the field.

Output

The node outputs JSON data representing the updated submitter object returned from the DocuSeal API. This includes all current properties of the submitter after the update, such as identifiers, contact info, roles, completion status, configured fields, and any other metadata managed by the service.

There is no indication that this node outputs binary data.

Dependencies

  • Requires an active connection to the DocuSeal API via an API key credential configured in n8n.
  • The node uses internal helper functions to prepare and send HTTP requests to the DocuSeal REST endpoints.
  • No additional external dependencies are needed beyond the configured API authentication.

Troubleshooting

  • Error: "At least one field must be updated"
    This error occurs if no update fields, field configurations, or field values are provided. Ensure you specify at least one property to update.

  • Invalid Submitter ID
    If the submitter ID does not exist or is invalid, the API will return an error. Verify the submitter ID before running the node.

  • Notification Failures
    If sending email or SMS notifications fails, check that the submitter has valid contact information and that your DocuSeal account supports these features.

  • Malformed Field Names or Values
    Field names must match those defined in the associated template. Incorrect names may cause the API to reject the update.

  • API Request Errors
    Network issues or invalid credentials will cause request failures. Confirm your API key is valid and network connectivity is stable.

Links and References

Discussion