Dropbox Sign Developer Documentation

import * as fs from 'fs';
import api from "@dropbox/sign"
import models from "@dropbox/sign"
const apiCaller = new api.TemplateApi();
apiCaller.username = "YOUR_API_KEY";
// apiCaller.accessToken = "YOUR_ACCESS_TOKEN";
const templateAddUserRequest: models.TemplateAddUserRequest = {
  emailAddress: "george@dropboxsign.com",
};
apiCaller.templateAddUser(
  "f57db65d3f933b5316d398057a36176831451a35", // templateId
  templateAddUserRequest,
).then(response => {
  console.log(response.body);
}).catch(error => {
  console.log("Exception when calling TemplateApi#templateAddUser:");
  console.log(error.body);
});

{
  "template": {
    "template_id": "f57db65d3f933b5316d398057a36176831451a35",
    "title": "Mutual NDA",
    "message": "Please sign this NDA as soon as possible.",
    "updated_at": 1570471067,
    "is_embedded": false,
    "is_creator": true,
    "can_edit": true,
    "is_locked": false,
    "metadata": {},
    "signer_roles": [
      {
        "name": "Outside Vendor",
        "order": 0
      },
      {
        "name": "Internal Manager",
        "order": 1
      }
    ],
    "cc_roles": [
      {
        "name": "Corporate Attorney"
      }
    ],
    "documents": [
      {
        "name": "mutual_nda.pdf",
        "index": 0,
        "field_groups": [
          {
            "name": "group1",
            "rule": {}
          }
        ],
        "form_fields": [
          {
            "type": "checkbox",
            "api_id": "b65e03_10",
            "height": 15,
            "name": "DepartmentA",
            "required": false,
            "signer": "1",
            "width": 15,
            "x": 117,
            "y": 19
          },
          {
            "type": "checkbox",
            "api_id": "b65e03_11",
            "height": 15,
            "name": "DepartmentB",
            "required": false,
            "signer": "2",
            "width": 15,
            "x": 118,
            "y": 41
          },
          {
            "type": "text",
            "api_id": "0ec7a7_1",
            "height": 30,
            "name": "VendorName",
            "required": true,
            "signer": "1",
            "width": 80,
            "x": 160,
            "y": 141
          },
          {
            "type": "text",
            "api_id": "0ec7a7_2",
            "height": 30,
            "name": "VendorTitle",
            "required": true,
            "signer": "2",
            "width": 80,
            "x": 160,
            "y": 181
          },
          {
            "type": "text",
            "api_id": "0ec7a7_3",
            "height": 30,
            "name": "ManagerName",
            "required": true,
            "signer": "2",
            "width": 80,
            "x": 160,
            "y": 221
          },
          {
            "type": "text",
            "api_id": "0ec7a7_4",
            "height": 30,
            "name": "ManagerTitle",
            "required": true,
            "signer": "2",
            "width": 80,
            "x": 160,
            "y": 251
          },
          {
            "type": "date_signed",
            "api_id": "0ec7a7_5",
            "height": 16,
            "name": "DateSigned",
            "required": true,
            "signer": "1",
            "width": 105,
            "x": 523,
            "y": 28
          }
        ],
        "custom_fields": [
          {
            "type": "text",
            "api_id": "78083014-32d8-4b5b-b65e-fe6010f3be64",
            "group": null,
            "height": 14,
            "name": "Effective Date",
            "required": false,
            "signer": null,
            "width": 84,
            "x": 378,
            "y": 36
          }
        ]
      }
    ],
    "accounts": [
      {
        "account_id": "5008b25c7f67153e57d5a357b1687968068fb465",
        "email_address": "me@dropboxsign.com",
        "is_locked": false,
        "is_paid_hs": true,
        "is_paid_hf": false,
        "quotas": {
          "api_signature_requests_left": 0,
          "documents_left": 3600000,
          "sms_verifications_left": 300000
        }
      },
      {
        "account_id": "",
        "email_address": "teammate@dropboxsign.com",
        "is_locked": false,
        "is_paid_hs": true,
        "is_paid_hf": false,
        "quotas": {
          "api_signature_requests_left": 0,
          "documents_left": 3600000,
          "sms_verifications_left": 300000
        }
      }
    ]
  }
}

Gives the specified Account access to the specified Template. The specified Account must be a part of your Team.

Authentication

AuthorizationBasic

Basic authentication of the form Basic <username:password>.

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

template_idstringRequired

The id of the Template to give the Account access to.

Request

This endpoint expects an object.

account_idstringOptional

The id of the Account to give access to the Template. NOTE: The account id prevails if email address is also provided.

email_addressstringOptionalformat: "email"

The email address of the Account to give access to the Template. NOTE: The account id prevails if it is also provided.

skip_notificationbooleanOptionalDefaults to false

If set to true, the user does not receive an email notification when a template has been shared with them. Defaults to false.

Response headers

X-RateLimit-Limitinteger

The maximum number of requests per hour that you can make.

X-RateLimit-Remaininginteger

The number of requests remaining in the current rate limit window.

X-Ratelimit-Resetinteger

The Unix time at which the rate limit will reset to its maximum.

Response

successful operation

templateobject

Contains information about the templates you and your team have created.

warningslist of objects or null

A list of warnings.

Add User to Template

Authentication

Path parameters

Request

Response headers

Response

Errors