Table of Contents

Class EditDocumentRequest

Namespace
BoldSign.Api.Model.EditDocument
Assembly
BoldSign.Api.dll

The edit document request.

[DataContract]
public class EditDocumentRequest
Inheritance
EditDocumentRequest
Inherited Members

Properties

AllowedSignatureTypes

Gets or sets the allowed signature types.

[DataMember(Name = "allowedSignatureTypes", EmitDefaultValue = false)]
public List<SignatureType> AllowedSignatureTypes { get; set; }

Property Value

List<SignatureType>

BrandId

Gets or sets the brand id.

[DataMember(Name = "brandId", EmitDefaultValue = false)]
public string BrandId { get; set; }

Property Value

string

CC

Gets or sets document cc.

[DataMember(Name = "cc", EmitDefaultValue = false)]
public IEnumerable<DocumentCC> CC { get; set; }

Property Value

IEnumerable<DocumentCC>

DisableEmails

Gets or sets a value indicating whether to enable disable emails. When disable emails is enabled, Reminder is automatically ignored.

[DataMember(Name = "disableEmails", EmitDefaultValue = false)]
public bool? DisableEmails { get; set; }

Property Value

bool?

DisableExpiryAlert

Gets or sets a value indicating whether disable expiry alert is true or false. This property will send the expiry alert email before the day of expiry for the pending signers. If the document expires in one day, the email will be sent before 2 hours of the expiry.

[DataMember(Name = "disableExpiryAlert", EmitDefaultValue = false)]
public bool? DisableExpiryAlert { get; set; }

Property Value

bool?

DisableSMS

Gets or sets a value indicating whether to enable disable sms.

[DataMember(Name = "disableSMS", EmitDefaultValue = false)]
public bool? DisableSMS { get; set; }

Property Value

bool?

DocumentDownloadOption

Gets or sets a value indicating whether to enable individual document downloads.

[DataMember(Name = "documentDownloadOption", EmitDefaultValue = false)]
public DocumentDownloadOption? DocumentDownloadOption { get; set; }

Property Value

DocumentDownloadOption?

DocumentId

Gets or sets the document id.

[DataMember(Name = "documentId", EmitDefaultValue = false)]
public string DocumentId { get; set; }

Property Value

string

DocumentInfo

Gets or sets the document information.

[DataMember(Name = "documentInfo", EmitDefaultValue = false)]
public IEnumerable<DocumentInfo> DocumentInfo { get; set; }

Property Value

IEnumerable<DocumentInfo>

DownloadFileName

Gets or sets the download file name.

[StringLength(250)]
[DataMember(Name = "downloadFileName", EmitDefaultValue = false)]
public string DownloadFileName { get; set; }

Property Value

string

EnableAuditTrailLocalization

Gets or sets a value indicating whether to enable a localization support for audit trail.

[DataMember(Name = "enableAuditTrailLocalization", EmitDefaultValue = false)]
public bool? EnableAuditTrailLocalization { get; set; }

Property Value

bool?

EnablePrintAndSign

Gets or sets a value indicating whether to enable print and sign mode.

[DataMember(Name = "enablePrintAndSign", EmitDefaultValue = false)]
public bool? EnablePrintAndSign { get; set; }

Property Value

bool?

EnableReassign

Gets or sets a value indicating whether to enable reassign mode.

[DataMember(Name = "enableReassign", EmitDefaultValue = false)]
public bool? EnableReassign { get; set; }

Property Value

bool?

EnableSigningOrder

Gets or sets a value indicating whether to enable signing order for the document signer.

[DataMember(Name = "enableSigningOrder", EmitDefaultValue = false)]
public bool? EnableSigningOrder { get; set; }

Property Value

bool?

ExpiryDateType

Gets or sets the expiry date type.

[DataMember(Name = "expiryDateType", EmitDefaultValue = false)]
public ExpiryDateType? ExpiryDateType { get; set; }

Property Value

ExpiryDateType?

ExpiryValue

Gets or sets the expiry value based on expiry date type.

[DataMember(Name = "expiryValue", EmitDefaultValue = false)]
public long? ExpiryValue { get; set; }

Property Value

long?

Files

Gets or sets list of files.

[DataMember(Name = "files", EmitDefaultValue = false)]
public List<EditDocumentFile> Files { get; set; }

Property Value

List<EditDocumentFile>

FormGroups

Gets or sets form group values for grouped form fields.

[DataMember(Name = "formGroups", EmitDefaultValue = false)]
public List<FormGroup> FormGroups { get; set; }

Property Value

List<FormGroup>

GroupSignerSettings

Gets or sets the group signer settings for group signers.

[DataMember(Name = "groupSignerSettings", EmitDefaultValue = false)]
public GroupSignerSettings GroupSignerSettings { get; set; }

Property Value

GroupSignerSettings

HideDocumentId

Gets or sets a value indicating whether to remove the document ID watermark from all the PDF pages of the document.

[DataMember(Name = "hideDocumentId", EmitDefaultValue = false)]
public bool? HideDocumentId { get; set; }

Property Value

bool?

Labels

Gets or sets the labels.

[DataMember(Name = "labels", EmitDefaultValue = false)]
public IEnumerable<string> Labels { get; set; }

Property Value

IEnumerable<string>

Message

Gets or sets document message or description.

[StringLength(5000, ErrorMessage = "The message exceeds the limit of {1} characters")]
[DataMember(Name = "message", EmitDefaultValue = false)]
public string Message { get; set; }

Property Value

string

MetaData

Gets or sets the metadata value.

[DataMember(Name = "metaData", EmitDefaultValue = false)]
public Dictionary<string, string> MetaData { get; set; }

Property Value

Dictionary<string, string>

OnBehalfOf

Gets or sets the on behalf of email address.

[DataMember(Name = "onBehalfOf", EmitDefaultValue = false)]
public string OnBehalfOf { get; set; }

Property Value

string

RecipientNotificationSettings

Gets or sets the recipient notification settings.

[DataMember(Name = "recipientNotificationSettings", EmitDefaultValue = false)]
public RecipientNotificationSettings RecipientNotificationSettings { get; set; }

Property Value

RecipientNotificationSettings

ReminderSettings

Gets or sets the reminder settings.

[DataMember(Name = "reminderSettings", EmitDefaultValue = false)]
public ReminderSettings ReminderSettings { get; set; }

Property Value

ReminderSettings

ScheduledSendTime

Gets or sets the document scheduled date value.

[DataMember(Name = "scheduledSendTime", EmitDefaultValue = false)]
public long? ScheduledSendTime { get; set; }

Property Value

long?

Signers

Gets or sets document signers.

[DataMember(Name = "signers", EmitDefaultValue = false)]
public IEnumerable<EditDocumentSigner> Signers { get; set; }

Property Value

IEnumerable<EditDocumentSigner>

TextTagDefinitions

Gets or sets the text tags definitions declared in the list can be used in the document by using the definition ID.

[DataMember(Name = "textTagDefinition", EmitDefaultValue = false)]
public List<TextTagDefinition> TextTagDefinitions { get; set; }

Property Value

List<TextTagDefinition>

Title

Gets or sets document title.

[StringLength(256, ErrorMessage = "The title exceeds the limit of {1} characters")]
[DataMember(Name = "title", EmitDefaultValue = false)]
public string Title { get; set; }

Property Value

string

UseTextTags

Gets or sets a value indicating whether to convert the text tags to form fields.

[DataMember(Name = "useTextTags", EmitDefaultValue = false)]
public bool UseTextTags { get; set; }

Property Value

bool