Interface CreateEnvelopeRequest

Request to create (and optionally send) a signature envelope.

interface CreateEnvelopeRequest {
    documents: SignatureDocumentInput[];
    message?: string;
    metadata?: Record<string, string>;
    recipients: SignatureRecipientInput[];
    sendImmediately?: boolean;
    title: string;
}

Index

Properties

documents message? metadata? recipients sendImmediately? title

Properties

documents

documents: SignatureDocumentInput[]

`Optional`message

message?: string

`Optional`metadata

metadata?: Record<string, string>

Provider custom fields / envelope metadata.

recipients

recipients: SignatureRecipientInput[]

`Optional`sendImmediately

sendImmediately?: boolean

true → send immediately ('sent'); false → create as draft ('created'). Defaults to true.

title

title: string

Email subject / envelope title.