DocuSeal icon

DocuSeal

Create documents, manage templates, and handle submissions with DocuSeal

Actions9

Overview

The Submitter: Update operation in this custom n8n node allows you to update the details of a submitter in DocuSeal. This includes modifying their contact information, status, role, notification preferences, and associated field values. It is useful for workflows where you need to programmatically manage or correct submitter data after initial creation—such as updating an email address, marking a submitter as completed, or sending notifications.

Practical examples:

  • Automatically mark a submitter as "completed" when a related process finishes.
  • Update a submitter's email or phone number if they provide new contact info.
  • Change the role or name of a submitter based on business logic.
  • Send a custom message or redirect URL upon completion.

Properties

Below are the supported input properties for the Submitter: Update operation:

Display Name Type Description
Environment options Choose between production and test environment.
Submitter ID number ID of the submitter to retrieve or update. (Required)
Completed boolean Whether to mark the submitter as completed and auto-signed via API.
Completed Redirect URL string URL to redirect the submitter to after completion.
Email string Email address of the submitter.
External ID string Your application-specific unique string key to identify this submitter.
Fields json List of field configurations to update. Format:
[{"name": "...", "default_value": "...", ...}]
Message json Custom email message for this submitter. Format:
{"subject": "...", "body": "..."}
Name string Name of the submitter.
Phone string Phone number of the submitter.
Role string Role of the submitter.
Send Email boolean Whether to send an email notification to the submitter.
Send SMS boolean Whether to send an SMS notification to the submitter.
Values json Pre-filled values for fields. Format:
{"Field Name": "Value"}

Output

The output will be a JSON object representing the updated submitter. The structure typically includes:

{
  "id": 123,
  "email": "user@example.com",
  "name": "User Name",
  "role": "Signer",
  "completed": true,
  "completed_redirect_url": "https://example.com/redirect",
  "external_id": "custom-key-001",
  "fields": [
    {
      "name": "Field Name",
      "default_value": "Value",
      "readonly": false,
      "required": true,
      "preferences": {
        "font_size": 12,
        "align": "left"
      }
    }
  ],
  "message": {
    "subject": "Custom Subject",
    "body": "Custom Body"
  },
  "phone": "+1234567890",
  "send_email": true,
  "send_sms": false,
  "values": {
    "Field Name": "Value"
  },
  ...
}
  • The actual fields returned may vary depending on what was updated and the DocuSeal API response.
  • If an error occurs and "Continue On Fail" is enabled, the output will include an error field with the error message.

Dependencies

  • External Service: Requires access to the DocuSeal API.
  • API Credentials: You must configure valid DocuSeal API credentials in n8n (credential type: docusealApi).
  • Environment Variable: None specific, but ensure network access to DocuSeal endpoints.

Troubleshooting

Common Issues:

  • Missing Required Fields: If "Submitter ID" is not provided, the node will fail.
  • Invalid Field Formats: Supplying malformed JSON in "Fields", "Message", or "Values" will result in errors.
  • Empty or Invalid Arrays: The "Fields" property must be a valid array if provided.
  • API Errors: If the DocuSeal API returns an error (e.g., invalid submitter ID), the node will throw an error.

Error Messages & Resolutions:

  • "Submitters parameter must be a valid array with at least one submitter object"
    → Ensure the "Fields" property is a non-empty array of objects with required keys.
  • "Error creating submission: ..."
    → Indicates an issue with the API request; check your input data and API credentials.
  • "Cannot read property '...' of undefined"
    → Likely due to missing or incorrectly named input properties.

Links and References

Discussion