Skip to navigation
How-to guides

How to send an envelope with recipient information

View as Markdown

This topic demonstrates how to create an envelope in a workspace with the Workspaces API and send it with recipient information using the eSignature REST API.

Run this code example from our Quickstart or launcher projects: Bash, C#, Java, Node.js, PowerShell.

Required data

Running the code in this how-to requires this data:

Data elementDescription
{API_ACCOUNT_ID}A GUID value that identifies your account. This value is automatically generated by Docusign for any account you create. Copy the value from the API Account ID field on the Apps and Keys page.
{DOCUMENT_ID}A GUID value that identifies a document within a workspace. To return a list of your workspace document IDs, use the WorkspaceDocuments: getWorkspaceDocuments method.
{ESIGN_BASE_PATH}A string value that forms the root of the URL required to make calls to the eSignature REST API. The base path value in the example code is set to target the developer environment at
https://<domain>/restapi
Where <domain> is demo.docusign.net for the developer environment and is the result of the GetUserInfo call in production.
{SIGNER_EMAIL}A string value for the email address where the signer will receive a notification of the signing request.
{SIGNER_NAME}A string value for the full name of the signer.
{WORKSPACES_BASE_PATH}A string value that forms the root of the URL required to make API calls. The base path value in the example code is set to target the developer environment at
https://<domain>
Where <domain> is https://api-d.docusign.com/v1 for the developer environment and https://api.docusign.com/v1 for production.
{WORKSPACE_ID}A GUID value that identifies your workspace. To return a list of your workspace IDs, use the Workspaces: getWorkspaces method.

Step 1. Obtain your OAuth token

To make the API calls shown in this how-to, you need a valid OAuth access token. Docusign supports access tokens for three different recommended OAuth grant types: Public Authorization Code Grant, Confidential Authorization Code Grant, and JSON Web Token (JWT) Grant. Choose the OAuth grant type appropriate for your scenario.

Wondering which grant type suits your integration? See Authenticate for guidance on your options to get an OAuth token.

Workspaces OAuth access tokens are the same ones used for our eSignature REST API, although you must request the signature scope and one or more Workspaces scopes to call the Workspaces API.

See Workspaces authentication for details and the full list of Workspaces scopes.

Three icons that represent the three methods a user can use to obtain an OAuth token: JSON Web Token (JWT), Public Authorization Code Grant (ACG), and Confidential Authorization Code grant

Step 2. Construct your API headers

After you have a valid OAuth access token, you are ready to construct the API headers. These same headers will be used for both API calls shown below. Construct your headers like this, but make sure to substitute your valid OAuth access token for {ACCESS_TOKEN}.

Although this how-to uses two different APIs, both accept the same access token and headers because the signature scope required by the eSignature REST API also applies to the Workspaces API.

declare -a Headers=('--header' "Authorization: Bearer ${ACCESS_TOKEN}" \
    '--header' "Accept: application/json" \
    '--header' "Content-Type: application/json")

Step 3. Construct the request body for a workspace envelope draft

Next, construct a request body for a workspace envelope draft. Set an envelope_name and insert the appropriate workspace document ID for {DOCUMENT_ID}.

printf \
'{
    "envelope_name": "Example Workspace Envelope",
    "document_ids": ["'"${document_id}"'"]
}' >> $request_data

Step 4. Call the Workspaces API

Now that you have constructed your API headers and request body, make a POST request to the Workspaces: createWorkspaceEnvelope endpoint and include the request body to create a workspace envelope draft. Here’s how you make the call, but make sure to substitute your API account ID for {API_ACCOUNT_ID}, your workspaces base path for {WORKSPACES_BASE_PATH}, and the desired workspace ID for {WORKSPACE_ID}.

Save the envelope_id from the response; you’ll need it in Step 6 to update and send the envelope.

Status=$(curl -s -w "%{http_code}\n" -i \
     --request POST ${workspaces_base_path}/accounts/${account_id}/workspaces/${workspace_id}/envelopes \
    "${Headers[@]}" \
    --data-binary @${request_data} \
    --output ${response})

Step 5. Construct the request body to update and send the envelope

Now that you have created an envelope that is associated with a workspace, use the eSignature REST API to update the envelope with tabs and recipient information. Set the status to sent to send the envelope.

printf \
'{
    "emailSubject": "Please sign this document",
    "recipients": {
        "signers": [
            {
                "email": "'"${SIGNER_EMAIL}"'",
                "name": "'"${SIGNER_NAME}"'",
                "recipientId": "1",
                "routingOrder": "1",
                "tabs": {
                    "signHereTabs": [
                        {
                            "anchorString": "/sn1/",
                            "anchorUnits": "pixels",
                            "anchorXOffset": "20",
                            "anchorYOffset": "10"
                        }
                    ]
                }
            }
        ]
    },
    "status": "sent"
}' >> $request_data

Step 6. Call the eSignature REST API

Make a PUT request to the Envelopes:update endpoint and include the request body to send the workspace envelope with recipient information. Here’s how you make the call, but make sure to substitute your API account ID for {API_ACCOUNT_ID}, your eSignature base path for {ESIGN_BASE_PATH}, and the envelope ID saved from step 4 for the {envelope_id}.

View the source code for this how-to on GitHub: Bash, C#, Java, Node.js, PowerShell

Status=$(curl -s -o "${response}" -w "%{http_code}" \
  --request PUT "${esign_base_path}/v2.1/accounts/${account_id}/envelopes/${envelope_id}" \
  "${Headers[@]}" \
  --data-binary @"${request_data}")

Expected response

If you run this code example from our Quickstart or launcher projects, you should see a JSON response similar to the code shown.

In addition, envelope recipients are automatically granted Participate access to the workspace and will receive consolidated email updates from Docusign Workspaces.

Sample response
{
  "envelopeId": "6a1ded37-xxxx-xxxx-xxxx-f081d428807d",
  "recipientUpdateResults": [
    {
      "recipientId": "1"
    }
  ],
  "tabUpdateResults": {
    "signHereTabs": [
      {
        "isSealSignTab": "false",
        "scaleValue": "0",
        "optional": "false",
        "documentId": "2xxxx1",
        "recipientId": "1",
        "pageNumber": "1",
        "xPosition": "205",
        "yPosition": "175",
        "width": "0",
        "height": "0",
        "anchorString": "/sn1/",
        "anchorXOffset": "20",
        "anchorYOffset": "10",
        "anchorUnits": "pixels",
        "anchorCaseSensitive": "false",
        "anchorMatchWholeWord": "true",
        "anchorHorizontalAlignment": "left",
        "anchorTabProcessorVersion": "v1_3",
        "tabId": "c8f72abd-xxxx-xxxx-xxxx-9d525531ad4a",
        "tabType": "signhere"
      }
    ]
  }
}

Next steps