Changing a Recipient

The Change Recipient feature enables a recipient to delegate their signature to another recipient. The delegating recipient must provide the email address and full name of the delegate. Optionally, the delegating recipient can also provide an email message for the delegate. Both recipients are notified of the recipient change and are copied on the email message. If a recipient has delegated their signature, the transaction creator is also informed.

The following code will do this:

HTTP Request

POST /api/cs-packages/{packageId}/roles

JS

HTTP Headers

Accept: application/json 
Content-Type: application/json 
Authorization: Bearer access_token

JS

Request Payload

{ "id": "Signer5", "reassign": true, "type": "SIGNER", "signers": [ { "email": "signer5@example.com", "firstName": "John", "lastName": "Smith", "id": "Signer5" } ], "name": "Signer5" }

JS

For a complete description of each field, see the Request Payload Table below.

Response Payload

{ "id": "Signer5", "data": null, "specialTypes": [], "emailMessage": null, "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" }

JS

Request Payload Table

Property	Type	Editable	Required	Default	Sample Values
id	string	Yes	No	n/a	`Signer5`
reassign	boolean	Yes	No	false	`true/false`
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	`signer5@example.com`
firstName	string	Yes	No	n/a	`John`
lastName	string	Yes	No	n/a	`Smith`
id	string	Yes	No	n/a	`Signer5`