DocuSignClient.AddRecipientToEnvelopeAsync Method

Definition

Add recipient to an envelope (V2)

public virtual System.Threading.Tasks.Task<Azure.Connectors.Sdk.DocuSign.Models.Signer> AddRecipientToEnvelopeAsync(string account, string envelope, Azure.Connectors.Sdk.DocuSign.Models.AdditionalRecipientParamsSchema input, string recipientType, string clientUserId = default, string embeddedRecipientStartURL = default, string signingOrder = default, string emailNotificationLanguage = default, string emailNotificationSubject = default, string emailNotificationBody = default, string note = default, string roleName = default, int? sMSCountryCode = default, int? sMSPhoneNumber = default, string signingGroup = default, string signatureType = default, string verificationWorkflow = default, System.Threading.CancellationToken cancellationToken = default);
abstract member AddRecipientToEnvelopeAsync : string * string * Azure.Connectors.Sdk.DocuSign.Models.AdditionalRecipientParamsSchema * string * string * string * string * string * string * string * string * string * Nullable<int> * Nullable<int> * string * string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Connectors.Sdk.DocuSign.Models.Signer>
override this.AddRecipientToEnvelopeAsync : string * string * Azure.Connectors.Sdk.DocuSign.Models.AdditionalRecipientParamsSchema * string * string * string * string * string * string * string * string * string * Nullable<int> * Nullable<int> * string * string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Connectors.Sdk.DocuSign.Models.Signer>
Public Overridable Function AddRecipientToEnvelopeAsync (account As String, envelope As String, input As AdditionalRecipientParamsSchema, recipientType As String, Optional clientUserId As String = Nothing, Optional embeddedRecipientStartURL As String = Nothing, Optional signingOrder As String = Nothing, Optional emailNotificationLanguage As String = Nothing, Optional emailNotificationSubject As String = Nothing, Optional emailNotificationBody As String = Nothing, Optional note As String = Nothing, Optional roleName As String = Nothing, Optional sMSCountryCode As Nullable(Of Integer) = Nothing, Optional sMSPhoneNumber As Nullable(Of Integer) = Nothing, Optional signingGroup As String = Nothing, Optional signatureType As String = Nothing, Optional verificationWorkflow As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Signer)

Parameters

account
String

Account

envelope
String

Envelope

input
AdditionalRecipientParamsSchema

The request body.

recipientType
String

Recipient type

clientUserId
String

Client User ID

embeddedRecipientStartURL
String

Embedded recipient start URL

signingOrder
String

Signing order

emailNotificationLanguage
String

Email notification language

emailNotificationSubject
String

Email notification subject

emailNotificationBody
String

Email notification body

note
String

Note

roleName
String

Role name

sMSCountryCode
Nullable<Int32>

SMS Country Code

sMSPhoneNumber
Nullable<Int32>

SMS Phone Number

signingGroup
String

Signing Group

signatureType
String

Signature type

verificationWorkflow
String

Verification workflow

cancellationToken
CancellationToken

Cancellation token.

Returns

The Add recipient to an envelope (V2) response.

Remarks

Add recipient to an envelope.

Applies to