Azure Connectors Node.js SDK
    Preparing search index...

    Interface UpdateEnvelopeRecipientOptions

    Options for the updateEnvelopeRecipient operation.

    interface UpdateEnvelopeRecipientOptions {
        abortSignal?: AbortSignalLike;
        clientUserId?: string;
        countryCode?: string;
        emailNotificationBody?: string;
        emailNotificationLanguage?: string;
        emailNotificationSubject?: string;
        embeddedRecipientStartUrl?: string;
        note?: string;
        onResponse?: ConnectorRawResponseCallback;
        phoneNumber?: string;
        roleName?: string;
        routingOrder?: string;
        signatureType?: string;
        signingGroupId?: string;
        tracingOptions?: OperationTracingOptions;
    }

    Hierarchy (View Summary)

    Index
    abortSignal?: AbortSignalLike

    Signal used to cancel the operation.

    clientUserId?: string

    Client user ID for embedded signer

    countryCode?: string

    For SMS notifications, the country code, without leading + sign.

    emailNotificationBody?: string

    Body of the email notification.

    emailNotificationLanguage?: string

    Language for the email notification.

    emailNotificationSubject?: string

    Subject of the email notification.

    embeddedRecipientStartUrl?: string

    A sender-provided URL string for redirecting an embedded recipient.

    note?: string

    Custom note for the recipient.

    Callback invoked with the complete response before the operation returns or throws.

    phoneNumber?: string

    Signer email or SMS phone required. Exclude country code for phone number.

    roleName?: string

    Role name associated with the recipient.

    routingOrder?: string

    The signing order of the recipient.

    signatureType?: string

    Docusign standards-based-signature (SBS) types.

    signingGroupId?: string

    Signing Group

    tracingOptions?: OperationTracingOptions

    Context used to parent the operation's tracing span.