Send multiple templates for signing to several recipients with Java SDK using the API

Send a group of templates to be signed by multiple recipients without any order or in a specific order. Using the SignNow API you can create templates, organize them in a group and send them for signing within your custom app or website.

Node.js

C#

Java

Copy

'use strict';
 
const signnow = require('@signnow/api-client')({
  credentials: 'BASE64_ENCODED_CLIENT_CREDENTIALS',
  production: true, // if false then uses eval server
});
const createDocumentGroupInvite = signnow.documentGroup.invite;
 
const token = 'YOUR_ACCESS_TOKEN';
const id = 'DOCUMENT_GROUP_ID';
 
/**
 * see API Reference for invite configuration info
 * at https://signnow.github.io/SignNowNodeSDK/class/lib/documentGroup.js~DocumentGroup.html#static-method-invite
 */
const data = {
  invite_steps: [
    {
      order: 1,
      invite_emails: [
        {
          email: 'Email of Signer 1',
          subject: 'Signer 1 Needs Your Signature',
          message: 'Signer 1 invited you to sign Document 1',
          expiration_days: 30,
          reminder: 0,
        },
      ],
      invite_actions: [
        {
          email: 'Email of Signer 1',
          role_name: 'Signer 1',
          action: 'sign',
          document_id: 'Document 1 ID',
          allow_reassign: '0',
          decline_by_signature: '0',
        },
      ],
    },
    {
      order: 2,
      invite_emails: [
        {
          email: 'Email of Signer 2',
          subject: 'Signer 2 Needs Your Signature',
          message: 'Signer 2 invited you to sign Document 2',
          expiration_days: 30,
          reminder: 0,
        },
      ],
      invite_actions: [
        {
          email: 'Email of Signer 2',
          role_name: 'Signer 2',
          action: 'sign',
          document_id: 'Document 2 ID',
          allow_reassign: '0',
          decline_by_signature: '0',
        },
      ],
    },
  ],
};
 
/**
 * @param {Object} res
 * @param {string} res.id - ID of created Document Group invitation
 * @param {?string} res.pending_invite_link
 */
const handleResponse = res => {
  console.log(res);
};
 
const handleError = err => {
  console.error(err);
};
 
createDocumentGroupInvite({
  token,
  id,
  data,
}, (err, res) => {
  if (err) {
    handleError(err);
  } else {
    handleResponse(res);
  }
});

public class DocumentGroupSendInviteModel
    {
        public IEnumerable<InviteSteps> invite_steps { get; set; }
        public IEnumerable<CompletionEmails> completion_emails { get; set; }
    }
 
    public class InviteSteps
    {
        public int order { get; set; }
        public IEnumerable<InviteEmails> invite_emails { get; set; }
        public IEnumerable<InviteActions> invite_actions { get; set; }
    }
 
    public class InviteEmails
    {
        public string email { get; set; }
        public int disabled { get; set; }
        public string subject { get; set; }
        public string message { get; set; }
    }
 
    public class InviteActions
    {
        public string email { get; set; }
        public string role_name { get; set; }
        public string action { get; set; }
        public string document_id { get; set; }
        public int allow_reassign { get; set; }
        public Authentication authentication { get; set; }
    }
 
    public class Authentication
    {
        public string type { get; set; }
        public string value { get; set; }
    }
 
    public class CompletionEmails
    {
        public string email { get; set; }
        public int disabled { get; set; }
        public string subject { get; set; }
        public string message { get; set; }
    }
 
    public enum DocumentGroupAction
    {
        sign,
        view
    }
public class CreateResponseModel
    {
        public string id { get; set; }
    }
public partial class RestSharpSamples
    {
        public static CreateResponseModel DocumentGroupSendInvites(string apiUrl, string accessToken, string groupId, DocumentGroupSendInviteModel invites)
        {
            var client = new RestClient { BaseUrl = new Uri(apiUrl) };
 
            var request = new RestRequest($"/documentgroup/{groupId}/groupinvite", Method.POST)
                .AddHeader("Accept", "application/json")
                .AddHeader("Authorization", $"Bearer {accessToken}");
 
            request.RequestFormat = DataFormat.Json;
            request.AddBody(invites);
            var response = client.Execute(request);
 
            if (response.StatusCode != HttpStatusCode.OK)
            {
                throw new Exception(response.Content);
            }
 
            return JsonConvert.DeserializeObject<CreateResponseModel>(response.Content);
        }
    }

try {
    final String roleNameOne = "Signer role";
    final String roleNameTwo = "Another signer role";
 
    //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 = roleNameOne;
    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 = roleNameTwo;
    sign2.label = "Your signature here";
 
    //update document with signature field
    cli.documentsService().updateDocumentFields(documentId1, Arrays.asList(sign, sign2));
 
    String documentGroupId = cli.documentGroupsService().createDocumentGroup(Arrays.asList(documentId1, documentId2), "Document Group 1");
 
    //configure invite for document group
    GroupInvite gInvite = new GroupInvite();
    //competition emails
    GroupInvite.Email completeEmail = new GroupInvite.Email();
    completeEmail.email = "author@yourcompany.com";
    completeEmail.message = "completion message";
    completeEmail.subject = "completion message subject";
    gInvite.completionEmails.add(completeEmail);
 
    //invite steps (at least one)
    GroupInvite.InviteStep inviteStep = new GroupInvite.InviteStep();
    inviteStep.order = 1;
    //step action to take
    GroupInvite.InviteAction signAction = new GroupInvite.InviteAction();
    signAction.documentId = documentId1;
    signAction.roleName = roleNameOne;
    signAction.email = "signer@client.biz";
    inviteStep.inviteActions.add(signAction);
    gInvite.inviteSteps.add(inviteStep);
 
    //second step
    inviteStep = new GroupInvite.InviteStep();
    //follows after the first one
    inviteStep.order = 2;
    //step action to take
    signAction = new GroupInvite.InviteAction();
    signAction.documentId = documentId1;
    signAction.roleName = roleNameTwo;
    signAction.email = "signer2@client.biz";
    inviteStep.inviteActions.add(signAction);
    gInvite.inviteSteps.add(inviteStep);
 
    //create invite for document group
    String inviteId = cli.documentGroupsService().createDocumentGroupInvite(documentGroupId, gInvite);
} catch (SNException e) {
    e.printStackTrace();
}

View full API reference

Create a bulk invite for templates and send it to multiple recipients

Use this sample code to send multiple templates for signing to several recipients at once.

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