ASP.NET Web API Help Page

PATCH nano/envelope-recipients/{envelopeRecipientId}

Updates an envelope recipient.

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.
email	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

Sample:

{
  "declined": "2026-01-10T23:36:24.6431149Z",
  "declinedReason": "sample String 1",
  "delivered": "2026-01-10T23:36:24.6431149Z",
  "email": "sample String 2",
  "name": "sample String 3",
  "recipientGuid": "25161426-047a-494b-ae6e-032b533a1f97",
  "recipientType": "sample String 5",
  "roleName": "sample String 6",
  "sent": "2026-01-10T23:36:24.6431149Z",
  "signed": "2026-01-10T23:36:24.6431149Z",
  "signerId": "sample String 7",
  "status": "sample String 8",
  "envelope": "9",
  "id": "10",
  "person": "1"
}

text/html

Sample:

{"declined":"2026-01-10T23:36:24.6431149Z","declinedReason":"sample String 1","delivered":"2026-01-10T23:36:24.6431149Z","email":"sample String 2","name":"sample String 3","recipientGuid":"25161426-047a-494b-ae6e-032b533a1f97","recipientType":"sample String 5","roleName":"sample String 6","sent":"2026-01-10T23:36:24.6431149Z","signed":"2026-01-10T23:36:24.6431149Z","signerId":"sample String 7","status":"sample String 8","envelope":"9","id":"10","person":"1"}

application/xml, text/xml

Sample:

<EnvelopeRecipient xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Declined>2026-01-10T23:36:24.6431149Z</Declined>
  <DeclinedReason>sample String 1</DeclinedReason>
  <Delivered>2026-01-10T23:36:24.6431149Z</Delivered>
  <Email>sample String 2</Email>
  <Name>sample String 3</Name>
  <RecipientGuid>25161426-047a-494b-ae6e-032b533a1f97</RecipientGuid>
  <RecipientType>sample String 5</RecipientType>
  <RoleName>sample String 6</RoleName>
  <Sent>2026-01-10T23:36:24.6431149Z</Sent>
  <Signed>2026-01-10T23:36:24.6431149Z</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:

Sample not available.

application/vnd.api+json

Sample:

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.
email	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

Sample:

{
  "declined": "2026-01-10T23:36:24.6587705Z",
  "declinedReason": "sample String 1",
  "delivered": "2026-01-10T23:36:24.6587705Z",
  "email": "sample String 2",
  "name": "sample String 3",
  "recipientGuid": "391c0948-c3dd-41ba-a4bd-ae2a19d1ba25",
  "recipientType": "sample String 5",
  "roleName": "sample String 6",
  "sent": "2026-01-10T23:36:24.6587705Z",
  "signed": "2026-01-10T23:36:24.6587705Z",
  "signerId": "sample String 7",
  "status": "sample String 8",
  "envelope": "9",
  "id": "10",
  "person": "1"
}

text/html

Sample:

{"declined":"2026-01-10T23:36:24.6587705Z","declinedReason":"sample String 1","delivered":"2026-01-10T23:36:24.6587705Z","email":"sample String 2","name":"sample String 3","recipientGuid":"391c0948-c3dd-41ba-a4bd-ae2a19d1ba25","recipientType":"sample String 5","roleName":"sample String 6","sent":"2026-01-10T23:36:24.6587705Z","signed":"2026-01-10T23:36:24.6587705Z","signerId":"sample String 7","status":"sample String 8","envelope":"9","id":"10","person":"1"}

application/xml, text/xml

Sample:

<EnvelopeRecipient xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Declined>2026-01-10T23:36:24.6587705Z</Declined>
  <DeclinedReason>sample String 1</DeclinedReason>
  <Delivered>2026-01-10T23:36:24.6587705Z</Delivered>
  <Email>sample String 2</Email>
  <Name>sample String 3</Name>
  <RecipientGuid>391c0948-c3dd-41ba-a4bd-ae2a19d1ba25</RecipientGuid>
  <RecipientType>sample String 5</RecipientType>
  <RoleName>sample String 6</RoleName>
  <Sent>2026-01-10T23:36:24.6587705Z</Sent>
  <Signed>2026-01-10T23:36:24.6587705Z</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:

Sample not available.