Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| envelopeRecipientId |
The envelope recipient identifier. |
integer |
Required |
Body Parameters
The envelope recipient.
Nano.EnvelopeRecipient| Name | Description | Type | Additional information |
|---|---|---|---|
| declined |
Gets or sets the declined. |
date |
None. |
| declinedReason |
Gets or sets the declined reason. |
string |
None. |
| delivered |
Gets or sets the delivered. |
date |
None. |
|
Gets or sets the email. |
string |
None. |
|
| name |
Gets or sets the name. |
string |
None. |
| recipientGuid |
Gets or sets the recipient unique identifier. |
globally unique identifier |
None. |
| recipientType |
Gets or sets the type of the recipient. |
string |
None. |
| roleName |
Gets or sets the role name. |
string |
None. |
| sent |
Gets or sets the sent. |
date |
None. |
| signed |
Gets or sets the signed. |
date |
None. |
| signerId |
Gets or sets the SignerId. |
string |
None. |
| status |
Gets or sets the status. |
string |
None. |
| envelope |
Gets or sets the envelope identifier. |
integer |
None. |
| id |
Gets or sets the envelope recipient identifier. |
integer |
None. |
| person |
Gets or sets the envelope identifier. |
integer |
None. |
Request Formats
application/json, text/json
{
"declined": "2025-04-25T18:19:54.4957079Z",
"declinedReason": "sample String 1",
"delivered": "2025-04-25T18:19:54.4957079Z",
"email": "sample String 2",
"name": "sample String 3",
"recipientGuid": "994dc105-0add-4238-ad0b-ee46da8c8369",
"recipientType": "sample String 5",
"roleName": "sample String 6",
"sent": "2025-04-25T18:19:54.4957079Z",
"signed": "2025-04-25T18:19:54.4957079Z",
"signerId": "sample String 7",
"status": "sample String 8",
"envelope": "9",
"id": "10",
"person": "1"
}
text/html
{"declined":"2025-04-25T18:19:54.4957079Z","declinedReason":"sample String 1","delivered":"2025-04-25T18:19:54.4957079Z","email":"sample String 2","name":"sample String 3","recipientGuid":"994dc105-0add-4238-ad0b-ee46da8c8369","recipientType":"sample String 5","roleName":"sample String 6","sent":"2025-04-25T18:19:54.4957079Z","signed":"2025-04-25T18:19:54.4957079Z","signerId":"sample String 7","status":"sample String 8","envelope":"9","id":"10","person":"1"}
application/xml, text/xml
<EnvelopeRecipient xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <Declined>2025-04-25T18:19:54.4957079Z</Declined> <DeclinedReason>sample String 1</DeclinedReason> <Delivered>2025-04-25T18:19:54.4957079Z</Delivered> <Email>sample String 2</Email> <Name>sample String 3</Name> <RecipientGuid>994dc105-0add-4238-ad0b-ee46da8c8369</RecipientGuid> <RecipientType>sample String 5</RecipientType> <RoleName>sample String 6</RoleName> <Sent>2025-04-25T18:19:54.4957079Z</Sent> <Signed>2025-04-25T18:19:54.4957079Z</Signed> <SignerId>sample String 7</SignerId> <Status>sample String 8</Status> <EnvelopeId>9</EnvelopeId> <EnvelopeRecipientId>10</EnvelopeRecipientId> <PersonId>1</PersonId> </EnvelopeRecipient>
application/x-www-form-urlencoded
Sample not available.
application/vnd.api+json
Sample not available.
Response Information
Resource Description
The updated envelope recipient.
Nano.EnvelopeRecipient| Name | Description | Type | Additional information |
|---|---|---|---|
| declined |
Gets or sets the declined. |
date |
None. |
| declinedReason |
Gets or sets the declined reason. |
string |
None. |
| delivered |
Gets or sets the delivered. |
date |
None. |
|
Gets or sets the email. |
string |
None. |
|
| name |
Gets or sets the name. |
string |
None. |
| recipientGuid |
Gets or sets the recipient unique identifier. |
globally unique identifier |
None. |
| recipientType |
Gets or sets the type of the recipient. |
string |
None. |
| roleName |
Gets or sets the role name. |
string |
None. |
| sent |
Gets or sets the sent. |
date |
None. |
| signed |
Gets or sets the signed. |
date |
None. |
| signerId |
Gets or sets the SignerId. |
string |
None. |
| status |
Gets or sets the status. |
string |
None. |
| envelope |
Gets or sets the envelope identifier. |
integer |
None. |
| id |
Gets or sets the envelope recipient identifier. |
integer |
None. |
| person |
Gets or sets the envelope identifier. |
integer |
None. |
Response Formats
application/json, text/json
{
"declined": "2025-04-25T18:19:54.4963906Z",
"declinedReason": "sample String 1",
"delivered": "2025-04-25T18:19:54.4963906Z",
"email": "sample String 2",
"name": "sample String 3",
"recipientGuid": "ab391aaf-081a-4e45-a793-c732df735293",
"recipientType": "sample String 5",
"roleName": "sample String 6",
"sent": "2025-04-25T18:19:54.4963906Z",
"signed": "2025-04-25T18:19:54.4963906Z",
"signerId": "sample String 7",
"status": "sample String 8",
"envelope": "9",
"id": "10",
"person": "1"
}
text/html
{"declined":"2025-04-25T18:19:54.4963906Z","declinedReason":"sample String 1","delivered":"2025-04-25T18:19:54.4963906Z","email":"sample String 2","name":"sample String 3","recipientGuid":"ab391aaf-081a-4e45-a793-c732df735293","recipientType":"sample String 5","roleName":"sample String 6","sent":"2025-04-25T18:19:54.4963906Z","signed":"2025-04-25T18:19:54.4963906Z","signerId":"sample String 7","status":"sample String 8","envelope":"9","id":"10","person":"1"}
application/xml, text/xml
<EnvelopeRecipient xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <Declined>2025-04-25T18:19:54.4963906Z</Declined> <DeclinedReason>sample String 1</DeclinedReason> <Delivered>2025-04-25T18:19:54.4963906Z</Delivered> <Email>sample String 2</Email> <Name>sample String 3</Name> <RecipientGuid>ab391aaf-081a-4e45-a793-c732df735293</RecipientGuid> <RecipientType>sample String 5</RecipientType> <RoleName>sample String 6</RoleName> <Sent>2025-04-25T18:19:54.4963906Z</Sent> <Signed>2025-04-25T18:19:54.4963906Z</Signed> <SignerId>sample String 7</SignerId> <Status>sample String 8</Status> <EnvelopeId>9</EnvelopeId> <EnvelopeRecipientId>10</EnvelopeRecipientId> <PersonId>1</PersonId> </EnvelopeRecipient>
application/vnd.api+json
Sample not available.