Customizing Invitation Emails
When sending transactions for signing you can customize the email message your signers receive. Customization can be applied on both the Transaction level and by the Signer.
Customizing emails by transaction
You can add a transaction level message for all signers in the transaction. The following code will do this.
HTTP Request
PUT <host domain>/api/sign/v1/cs-packages/{packageId}
HTTP Headers
Accept: application/json Content-Type: application/json Authorization: Bearer access_token
Request Payload
{ "emailMessage": "Changed package level email message." }
Customizing emails by Signer
You can add a transaction level message for each signer in the transaction. Signer level messages override the transaction level message. The following code will do this.
HTTP Request
POST <host domain>/api/sign/v1/cs-packages/{packageId}/roles
HTTP Headers
Accept: application/json Content-Type: application/json Authorization: Bearer access_token
Request Payload
{ "emailMessage": { "content": "Please sign the documents ASAP." } , "id": "Signer5", "reassign": true, "type": "SIGNER", "signers": [ { "email": "signer5@example.com", "firstName": "John", "lastName": "Smith", "id": "Signer5" } ], "name": "Signer5" }
For a complete description of each field, see the Request Payload Table 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": "signer5@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" }
Results Payload Table
Property |
Type |
Editable |
Required |
Default |
Sample Values |
---|---|---|---|---|---|
id |
string |
Yes |
No |
n/a |
|
emailMessage | |||||
content |
string |
Yes |
No |
n/a |
|
name |
string |
Yes |
No |
n/a |
|
id |
string |
Yes |
No |
n/a |
|
type |
string |
Yes |
No |
SIGNER |
|
signers | |||||
|
string |
Yes |
No |
n/a | |
firstName |
string |
Yes |
No |
n/a |
|
lastName |
string |
Yes |
No |
n/a |
|
id |
string |
Yes |
No |
n/a |
|