Send a group of documents for signing with Java Client using the API

Speed up document turnaround times and close important deals faster. With SignNow’s API, you can organize your documents into groups and quickly send them to one or multiple recipients.

Node.js

C#

cURL

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);
        }
    }

curl -X POST \
  http://{{url}}/documentgroup/{{document_group_id}}/groupinvite \
  -H 'Authorization: Bearer {bearer_token}' \
  -H 'Content-Type: application/json' \
  -d '{
   "invite_steps":[
      {
         "order": 1,
         "invite_emails":[
            {
               "email":"{{step1_email}}",
               "subject":"custom subject",
               "message":"custom message"
            }
         ],
         "invite_actions":[
            {
               "email":"{{step1_email}}",
               "role_name":"{{role_name}}",
               "action":"sign",
               "document_id":"{{document_id}}"
            }
         ]
      },
      {
        "order": 2,
         "invite_emails":[
            {
               "email":"{{step2_email}}",
               "subject":"custom subject",
               "message":"custom message"           
            }
         ],
         "invite_actions":[
            {
               "email":"{{step1_email}}",
               "role_name":"{{role_name}}",
               "action":"sign",
               "document_id":"{{document_id}}"
            }
         ] 
      }
   ]
}'

View full API reference

Enable customers to e-sign your documents in bulk

Use the sample code to group documents together and share them as a single package.

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