Email Message

The following guide shows you an example of how to customize the e-mail message received by a signer when a package is sent for signing.

When sending packages for signing, you can add an additional message in the e-mail your signers receive.

Package Level

You can add a package level message for your signers in the e-mail they receive after you’ve sent your package. Below is an example on how to build your package with a customized e-mail message.

DocumentPackage pkg = PackageBuilder.newPackageNamed("Example Package " + System.currentTimeMillis())
        .withEmailMessage("This is a package level email message.")
        ......
        .build();

Signer Level

Similarly, you can specify different messages in signer level. Below is an example on how to build your Signer object with a customized e-mail message.

To note, signer level message will overwrite the package level message.

Signer signer2 = SignerBuilder.newSignerWithEmail("signer2@mailinator.com")
        .withEmailMessage("This is a signer level email message for signer2.")
        ......
        .build();

The Code

Here’s an example showing you how to build a package with both package and signer level email messages.

DocumentPackage pkg1 = PackageBuilder.newPackageNamed("Example Package " + System.currentTimeMillis())
        .withSigner(SignerBuilder.newSignerWithEmail("signer1@mailinator.com" )
                .withFirstName("John")
                .withLastName("Smith"))
        .withSigner(SignerBuilder.newSignerWithEmail("signer2@mailinator.com" )
                .withFirstName("Marry")
                .withLastName("Doe")
                .withEmailMessage("This is a signer level email message for signer2."))
        .withDocument(DocumentBuilder.newDocumentWithName("document 1")
        		.fromFile("P:\\Documents\\documents-example\\Test PDF.pdf")
        		.withSignature(SignatureBuilder.signatureFor("signer1@mailinator.com")
        				.onPage(0)
        				.atPosition(100, 100)
        				.withSize(250, 75))
        		.withSignature(SignatureBuilder.signatureFor("signer2@mailinator.com")
        				.onPage(0)
        				.atPosition(200, 100)
        				.withSize(250, 75)))
        .withEmailMessage("This is a package level email message.")
        .build();

Running Your Code

Below is a screenshot of what your signers can expect in the e-mail they receive.

Signer1:
Capture
Signer2:
Capture

Get the Code

When sending packages for signing, you can add an additional message in the e-mail your signers receive.

Package Level

You can add a package level message for your signers in the e-mail they receive after you’ve sent your package. Below is an example on how to build your package with a customized e-mail message.

DocumentPackage pkg = PackageBuilder.NewPackageNamed("Example Package " + System.DateTime.Now)
        .WithEmailMessage("This is a package level email message.")
        ......
        .Build();

Signer Level

Similarly, you can specify different messages in signer level. Below is an example on how to build your Signer object with a customized e-mail message.

To note, signer level message will overwrite the package level message.

Signer signer2 = SignerBuilder.NewSignerWithEmail("signer2@mailinator.com")
        .WithEmailMessage("This is a signer level email message for signer2.")
        ......
        .Build();

The Code

Here’s an example showing you how to build a package with both package and signer level email messages.

DocumentPackage pkg1 = PackageBuilder.NewPackageNamed("Example Package " + System.DateTime.Now)
        .WithSigner(SignerBuilder.NewSignerWithEmail("signer1@mailinator.com" )
                .WithFirstName("John")
                .WithLastName("Smith"))
        .WithSigner(SignerBuilder.NewSignerWithEmail("signer2@mailinator.com" )
                .WithFirstName("Marry")
                .WithLastName("Doe")
                .WithEmailMessage("This is a signer level email message for signer2."))
        .WithDocument(DocumentBuilder.NewDocumentNamed("document 1")
        		.FromFile("P:\\Documents\\documents-example\\Test PDF.pdf")
        		.WithSignature(SignatureBuilder.SignatureFor("signer1@mailinator.com")
        				.OnPage(0)
        				.AtPosition(100, 100)
        				.WithSize(250, 75))
        		.WithSignature(SignatureBuilder.SignatureFor("signer2@mailinator.com")
        				.OnPage(0)
        				.AtPosition(200, 100)
        				.WithSize(250, 75)))
        .WithEmailMessage("This is a package level email message.")
        .Build();

Running Your Code

Below is a screenshot of what your signers can expect in the e-mail they receive.

Signer1:
Capture
Signer2:
Capture

Get the Code

When sending packages for signing, you can add an additional message in the e-mail your signers receive.

Package Level

You can add a package level message for your signers in the e-mail they receive after you’ve sent your package. Below is an example on how to modify package level message to your existing package.

HTTP Request
PUT /api/packages/{packageId}

HTTP Headers
Accept: application/json
Content-Type: application/json
Authorization: Basic api_key

Request Payload

{
  "emailMessage": "Changed package level email message."
}

Signer Level

Similarly, you can specify different messages in signer level. Below is an example on how to build your “roles” object with a customized e-mail message.

HTTP Request
POST /api/packages/{packageId}/roles

HTTP Headers
Accept: application/json
Content-Type: application/json
Authorization: Basic api_key

Request Payload

{
  "emailMessage": {
    "content": "Please sign the documents ASAP."
  },
  "id": "Signer5",
  "reassign": true,
  "type": "SIGNER",
  "signers": [
    {
      "email": "mail32@mailinator.com",
      "firstName": "John",
      "lastName": "Smith",
      "id": "Signer5"
    }
  ],
  "name": "Signer5"
}

For a complete description of each field, take a look at the JSON Properties section below.

Response Payload

{
  "id": "Signer5",
  "data": null,
  "specialTypes": [],
  "emailMessage": {
    "content": "Please sign the documents ASAP."
  },
  "attachmentRequirements": [],
  "locked": false,
  "reassign": true,
  "index": 0,
  "signers": [
    {
      "group": null,
      "language": "en",
      "signature": null,
      "id": "Signer5",
      "delivery": {
        "provider": false,
        "email": false,
        "download": false
      },
      "auth": {
        "scheme": "NONE",
        "challenges": []
      },
      "knowledgeBasedAuthentication": null,
      "data": null,
      "title": "",
      "company": "",
      "email": "mail32@mailinator.com",
      "firstName": "John",
      "lastName": "Smith",
      "external": null,
      "updated": "2017-11-16T16:53:01Z",
      "phone": "",
      "professionalIdentityFields": [],
      "userCustomFields": [],
      "address": null,
      "created": "2017-11-16T16:53:01Z",
      "name": "",
      "specialTypes": []
    }
  ],
  "name": "Signer5",
  "type": "SIGNER"
}

Running Your Code

Below is a screenshot of what your signers can expect in the e-mail they receive:

capture

Get the Code

JSON Properties

Property Type Editable Required Default Sample Value(s)
id string Yes No n/a Signer5
emailMessage
content string Yes No n/a Please sign the documents ASAP.
name string Yes No n/a Signer5
id string Yes No n/a Signer5
type string Yes No SIGNER SIGNER / SENDER
signers
email string Yes No n/a mail32@mailinator.com
firstName string Yes No n/a John
lastName string Yes No n/a Smith
id string Yes No n/a Signer5