DocuSign icon

DocuSign

Interact with the DocuSign eSignature REST API v2.1 — complete enterprise coverage

Actions341

Template Recipient → Create

AI-generated

Summary

Create a recipient role in a specified DocuSign template for a given account, defining the recipient type, role name, routing order, and optional recipient details such as name, email, and additional recipient settings.

Inputs

  • Account ID (required) — The DocuSign Account ID (GUID). Find it in DocuSign Admin → API and Keys.
  • Template ID (required) — The ID (GUID) of the template to which the recipient role will be added.
  • Recipient Type (required) — The type of recipient role to create, such as Signer, Carbon Copy, Certified Delivery, In-Person Signer, Agent, Editor, Intermediary, or Witness.
  • Role Name (required) — The name of the role (e.g., 'Signer 1', 'Manager') to identify this recipient in the template.
  • Routing Order — The routing order integer defining the sequence in which this recipient signs or receives the envelope; defaults to 1 if not set.
  • Additional Fields — Optional fields to provide default recipient details and settings, including default email and name, recipient ID, access code, ID check configuration, delivery method (email or SMS), email notification overrides, notes, and template locking or requirement flags. Also supports setting host and signer names and emails for In-Person signers.

Output shape

a JSON object representing the created template recipient role, including details of the recipient such as recipient ID and role information.

The response contains the newly created recipient role data as returned by DocuSign. No pagination applies as this is a create operation.

Links

Discussion