Personnalisation des e-mails d’invitation

Java SDK .NET SDK REST API APEX SDK

Java SDK

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

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

 DocumentPackage pkg1 = PackageBuilder.newPackageNamed("Example Package " + System.currentTimeMillis())   .withSigner(SignerBuilder.newSignerWithEmail("signer1@example.com" )   .withFirstName("John")   .withLastName("Smith"))   .withSigner(SignerBuilder.newSignerWithEmail("signer2@example.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@example.com")   .onPage(0)   .atPosition(100, 100)   .withSize(250, 75))   .withSignature(SignatureBuilder.signatureFor("signer2@example.com")   .onPage(0)   .atPosition(200, 100)   .withSize(250, 75)))    .withEmailMessage("This is a package level email message.")   .build(); 

.NET SDK

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

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

 DocumentPackage pkg1 = PackageBuilder.NewPackageNamed("Example Package " + System.DateTime.Now)   .WithSigner(SignerBuilder.NewSignerWithEmail("signer1@example.com" )   .WithFirstName("John")   .WithLastName("Smith"))   .WithSigner(SignerBuilder.NewSignerWithEmail("signer2@example.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@example.com")   .OnPage(0)   .AtPosition(100, 100)   .WithSize(250, 75))   .WithSignature(SignatureBuilder.SignatureFor("signer2@example.com")   .OnPage(0)   .AtPosition(200, 100)   .WithSize(250, 75)))    .WithEmailMessage("This is a package level email message.")   .Build(); 

REST API

Pour télécharger l’exemple complet de code, consultez notre site de partage de code .

Lors de l’envoi de transactions à signer, vous pouvez personnaliser entièrement les emails reçus par vos signataires. La personnalisation peut être appliquée aussi bien au niveau de la transaction que par le signataire.

Il y a une limite de 4 000 caractères pour les messages. La limite de 4 000 caractères s’applique au message tel qu’il est stocké, pas seulement au texte que vous voyez. Si votre message contient du HTML, les balises comptent dans la limite ainsi que le texte visible. Par exemple, <b>Hello</b> est stocké en 12 caractères, même si seulement 5 sont affichés. Ainsi, un message avec HTML peut dépasser la limite même lorsque le texte visible est bien en dessous de 4 000 caractères. Pour éviter cela, limitez la mise en forme HTML au minimum, ou laissez de la place en dessous de la limite lors de l’utilisation.

Personnalisation des e-mails par transaction

Vous pouvez ajouter un message au niveau de la transaction pour tous les signataires de la transaction. Le code suivant le fera.

Requête HTTP

PUT /api/packages/{packageId}

En-têtes HTTP

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

Charge utile de demande

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

Personnalisation des e-mails par signataire

Vous pouvez ajouter un message au niveau de la transaction pour chaque signataire dans la transaction. Les messages au niveau du signataire supplantent le message au niveau de la transaction. Le code suivant le fera.

Requête HTTP

POST /api/packages/{packageId}/roles

En-têtes HTTP

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

Charge utile de demande

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

Pour une description complète de chaque champ, voir le tableau des charges utiles de demande ci-dessous.

Charge utile de réponse

 {
	"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@example.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"
}

Résultats

Voici un exemple de ce à quoi vous pouvez vous attendre une fois votre code exécuté.

Table des charges utiles de requêtes