Home
Developers
Features
API for e-Signature Solutions
Use signNow Esignature API to Invite to sign document group

Use signNow Esignature API to Invite to sign document group

Change recipient details or update their email address even after you've sent out a document using the signNow API. Get full control over the process of collecting signatures with advanced options for editing your list of recipients.

Node.js

Java

Python

cURL

Copy

'use strict';
 
const signnow = require('@signnow/api-client')({
  credentials: 'BASE64_ENCODED_CLIENT_CREDENTIALS',
  production: true, // if false then uses eval server
});
const sendInvite = signnow.template.invite;
 
const id = 'TEMPLATE_ID_GOES_HERE';
const token = 'YOUR_ACCESS_TOKEN';
 
/**
 * @typedef {Object} SignerSettings
 * @property {string} email - signer's email
 * @property {string} role - ole name
 * @property {number} order - role signing order
 * @property {string} reassign - allow reassign signer
 * @property {string} decline_by_signature - signer can decline invite
 * @property {number} reminder - remind via email in days
 * @property {number} expiration_days - expiration of invite in days
 * @property {string} [subject] - specify subject of email
 * @property {string} [message] - specify body of email
 */
 
/**
 * @type {Object}
 * @property {string} document_id
 * @property {SignerSettings[]} to - array of signers
 * @property {string} from - email of sender
 * @property {string[]} [cc] - array with emails
 * @property {string} [subject] - specify subject of email
 * @property {string} [message] - specify body of email
 * @property {string} [on_complete] - on signing complete action
 */
const fieldInvite = {
  document_id: 'TEMPLATE_ID_GOES_HERE',
  to: [
    {
      email: 'EMAIL_OF_SIGNER_1',
      role: 'Signer 1',
      order: 1,
      reassign: '0',
      decline_by_signature: '0',
      reminder: 4,
      expiration_days: 27,
      subject: 'Field invite Signer1',
      message: 'Message1',
    },
    {
      email: 'EMAIL_OF_SIGNER_2',
      role: 'Signer 2',
      order: 1,
      reassign: '0',
      decline_by_signature: '0',
      reminder: 4,
      expiration_days: 27,
      subject: 'Field invite Signer2',
      message: 'Message2',
    },
  ],
  from: 'EMAIL_OF_SENDER',
};
 
/**
 * @param {Object} res
 * @param {string} res.status - e.g. 'success'
 */
const handleResponse = res => {
  console.log(res);
};
 
const handleError = err => {
  console.error(err);
};
 
sendInvite({
  data: {
    ...fieldInvite,
  },
  id,
  token,
}, (err, res) => {
  if (err) {
    handleError(err);
  } else {
    handleResponse(res);
  }
});

public class SendInviteModel
    {
        public IEnumerable<To> to { get; set; }
        public string from { get; set; }
        public object[] cc { get; set; }
        public string subject { get; set; }
        public string message { get; set; }
    }
 
    public class To
    {
        public string email { get; set; }
        public string role_id { get; set; }
        public string role { get; set; }
        public int order { get; set; }
        public string authentication_type { get; set; }
        public string password { get; set; }
        public int expiration_days { get; set; }
        public int reminder { get; set; }
        public string method { get; set; }
        public string phone { get; set; }
    }
public partial class RestSharpSamples
    {
        public static void SignatureInviteFromTemplate(string accessToken, string apiUrl, string templateId, SendInviteModel dataObj, string documentName = "", bool disableEmail = false)
        {
            var client = new RestClient { BaseUrl = new Uri(apiUrl) };
 
            var createDocumentrequest = new RestRequest("/template/" + templateId + "/copy", Method.POST)
                .AddHeader("Accept", "application/json")
                .AddHeader("Authorization", "Bearer " + accessToken);
 
            if (!string.IsNullOrEmpty(documentName))
            {
                createDocumentrequest.RequestFormat = DataFormat.Json;
                createDocumentrequest.AddBody(new { document_name = documentName });
            }
 
            var createDocumentResponse = client.Execute(createDocumentrequest);
 
            if (createDocumentResponse.StatusCode != HttpStatusCode.OK)
            {
                throw new Exception($"Can't create document from template. {createDocumentResponse.Content}");
            }
 
            var document = JsonConvert.DeserializeObject<CreateResponseModel>(createDocumentResponse.Content);
 
            var disable = (disableEmail) ? "?email=disable" : "";
            var request = new RestRequest("/document/" + document.id + "/invite" + disable, Method.POST)
                .AddHeader("Accept", "application/json")
                .AddHeader("Authorization", "Bearer " + accessToken);
 
            request.RequestFormat = DataFormat.Json;
            request.AddBody(dataObj);
 
            var response = client.Execute(request);
            if (response.StatusCode != HttpStatusCode.OK)
            {
                throw new Exception($"Cannot send invite. {response.Content}");
            }
        }
    }

try {
    //Create signature field in document
    Document.Field sign = new Document.Field();
    sign.x = 10;
    sign.y = 10;
    sign.height = 30;
    sign.width = 150;
    sign.type = Document.FieldType.SIGNATURE;
    sign.required = true;
    sign.pageNumber = 0;
    sign.role = "Signer role";
    sign.label = "Your signature here";
 
    Document.Field sign2 = new Document.Field();
    sign2.x = 10;
    sign2.y = 60;
    sign2.height = 30;
    sign2.width = 150;
    sign2.type = Document.FieldType.SIGNATURE;
    sign2.required = true;
    sign2.pageNumber = 0;
    sign2.role = "Another signer role";
    sign2.label = "Your signature here";
     
    //update document with signature field
    cli.documentsService().updateDocumentFields(documentId, Arrays.asList(sign, sign2));
     
    //create signers to roles mapping
    Document.InviteRole role1 = new Document.InviteRole("signer@client.biz", "Another signer role");
    role1.password = "password";
    Document.InviteRole role2 = new Document.InviteRole("signer2@client.biz", "Signer role");
    role2.password = "other_password";
 
    //execute request for invite
    Document.SigningInviteWithRolesRequest request = new Document.SigningInviteWithRolesRequest(
        "author@yourcompany.com",
        Arrays.asList(role1, role2)
    );
    request2.subject = "Document to sign";
    request2.message = "test FFI sign from cli";
    cli.documentsService().sendDocumentSignInvite(documentId, request);
} catch (SNException e) {
    e.printStackTrace();
}

import signnow_python_sdk

if __name__ == '__main__':
    signnow_python_sdk.Config(client_id="CLIENT_ID",
                              client_secret="CLIENT_SECRET",
                              environment="production")

# Enter your own credentials
    username = "USER_NAME"
    password = "USER_PASSWORD"
    template_id = "TEMPLATE_ID"

# Create access_token for the user
    access_token = signnow_python_sdk.OAuth2.request_token(username, password, '*')

to = [{
        "email": "testemail@signnow.com",
        "role_id": "",
        "role": "Signer 1",
        "order": 1
    },
    {
        "email": "testemail1@signnow.com",
        "role_id": "",
        "role": "Signer 2",
        "order": 2

}]

invite_payload = {
        "to": to,
        "from": username
    }

# Create a document from the template
    doc_id = signnow_python_sdk.Template.copy(access_token['access_token'], template_id, "New Doc From Template")

# Get document data
    document_data = signnow_python_sdk.Document.get(access_token['access_token'], doc_id['id'])

# Send signature invite
    invite_response = signnow_python_sdk.Document.invite(access_token['access_token'], doc_id['id'], invite_payload)

View full API reference

Correct a recipient’s email address after sending a document and avoid mistakes in signing the procedure

Replace addresses in one click and get instant notifications for signing new recipients

We provide developers with complete SDKs for all popular languages, allowing them to integrate e-signature workflows without writing a single line of code.
With our detailed documentation, integrating the signNow API is a breeze.
The signNow API not only provides you with e-signatures: use it to create fillable forms, request payments, and download & archive documents using simple API calls.

View full API reference

API Documentation

Learn how to get started with the signNow REST API, check out common API use cases, signNow SDKs and code samples.

See documentation

API Pricing

Once you’ve tested the signNow API in sandbox, choose the API subscription plan that best suits your business needs.

See pricing