AptlyStar

DocuSign

Send documents for e-signature via DocuSign

Nutzungsanweisungen

Create and send envelopes for e-signature, use templates, check signing status, download signed documents, and manage recipients with DocuSign.

Tools

docusign_send_envelope

Create and send a DocuSign envelope with a document for e-signature

Eingabe

ParameterTypErforderlichBeschreibung
emailSubjectstringJaEmail subject for the envelope
emailBodystringNeinEmail body message
signerEmailstringJaEmail address of the signer
signerNamestringJaFull name of the signer
ccEmailstringNeinEmail address of carbon copy recipient
ccNamestringNeinFull name of carbon copy recipient
filefileNeinDocument file to send for signature
statusstringNeinEnvelope status: "sent" to send immediately, "created" for draft (default: "sent")

Ausgabe

ParameterTypBeschreibung
envelopeIdstringCreated envelope ID
statusstringEnvelope status
statusDateTimestringStatus change datetime
uristringEnvelope URI

docusign_create_from_template

Create and send a DocuSign envelope using a pre-built template

Eingabe

ParameterTypErforderlichBeschreibung
templateIdstringJaDocuSign template ID to use
emailSubjectstringNeinOverride email subject (uses template default if not set)
emailBodystringNeinOverride email body message
templateRolesstringJaJSON array of template roles, e.g. [{"roleName":"Signer","name":"John","email":"john@example.com"}]
statusstringNeinEnvelope status: "sent" to send immediately, "created" for draft (default: "sent")

Ausgabe

ParameterTypBeschreibung
envelopeIdstringCreated envelope ID
statusstringEnvelope status
statusDateTimestringStatus change datetime
uristringEnvelope URI

docusign_get_envelope

Get the details and status of a DocuSign envelope

Eingabe

ParameterTypErforderlichBeschreibung
envelopeIdstringJaThe envelope ID to retrieve

Ausgabe

ParameterTypBeschreibung
envelopeIdstringEnvelope ID
statusstringEnvelope status (created, sent, delivered, completed, declined, voided)
emailSubjectstringEmail subject line
sentDateTimestringWhen the envelope was sent
completedDateTimestringWhen all recipients completed signing
createdDateTimestringWhen the envelope was created
statusChangedDateTimestringWhen the status last changed
voidedReasonstringReason the envelope was voided
signerCountnumberNumber of signers
documentCountnumberNumber of documents

docusign_list_envelopes

List envelopes from your DocuSign account with optional filters

Eingabe

ParameterTypErforderlichBeschreibung
fromDatestringNeinStart date filter (ISO 8601). Defaults to 30 days ago
toDatestringNeinEnd date filter (ISO 8601)
envelopeStatusstringNeinFilter by status: created, sent, delivered, completed, declined, voided
searchTextstringNeinSearch text to filter envelopes
countstringNeinMaximum number of envelopes to return (default: 25)

Ausgabe

ParameterTypBeschreibung
envelopesarrayArray of DocuSign envelopes
↳ envelopeIdstringUnique envelope identifier
↳ statusstringEnvelope status (created, sent, delivered, completed, declined, voided)
↳ emailSubjectstringEmail subject line
↳ sentDateTimestringISO 8601 datetime when envelope was sent
↳ completedDateTimestringISO 8601 datetime when envelope was completed
↳ createdDateTimestringISO 8601 datetime when envelope was created
↳ statusChangedDateTimestringISO 8601 datetime of last status change
totalSetSizenumberTotal number of matching envelopes
resultSetSizenumberNumber of envelopes returned in this response

docusign_void_envelope

Void (cancel) a sent DocuSign envelope that has not yet been completed

Eingabe

ParameterTypErforderlichBeschreibung
envelopeIdstringJaThe envelope ID to void
voidedReasonstringJaReason for voiding the envelope

Ausgabe

ParameterTypBeschreibung
envelopeIdstringVoided envelope ID
statusstringEnvelope status (voided)

docusign_download_document

Download a signed document from a completed DocuSign envelope

Eingabe

ParameterTypErforderlichBeschreibung
envelopeIdstringJaThe envelope ID containing the document
documentIdstringNeinSpecific document ID to download, or "combined" for all documents merged (default: "combined")

Ausgabe

ParameterTypBeschreibung
base64ContentstringBase64-encoded document content
mimeTypestringMIME type of the document
fileNamestringOriginal file name

docusign_list_templates

List available templates in your DocuSign account

Eingabe

ParameterTypErforderlichBeschreibung
searchTextstringNeinSearch text to filter templates by name
countstringNeinMaximum number of templates to return

Ausgabe

ParameterTypBeschreibung
templatesarrayArray of DocuSign templates
↳ templateIdstringTemplate identifier
↳ namestringTemplate name
↳ descriptionstringTemplate description
↳ sharedbooleanWhether template is shared
↳ createdstringISO 8601 creation date
↳ lastModifiedstringISO 8601 last modified date
totalSetSizenumberTotal number of matching templates
resultSetSizenumberNumber of templates returned in this response

docusign_list_recipients

Get the recipient status details for a DocuSign envelope

Eingabe

ParameterTypErforderlichBeschreibung
envelopeIdstringJaThe envelope ID to get recipients for

Ausgabe

ParameterTypBeschreibung
signersarrayArray of DocuSign recipients
↳ recipientIdstringRecipient identifier
↳ namestringRecipient name
↳ emailstringRecipient email address
↳ statusstringRecipient signing status (sent, delivered, completed, declined)
↳ signedDateTimestringISO 8601 datetime when recipient signed
↳ deliveredDateTimestringISO 8601 datetime when delivered to recipient
carbonCopiesarrayArray of carbon copy recipients
↳ recipientIdstringRecipient ID
↳ namestringRecipient name
↳ emailstringRecipient email
↳ statusstringRecipient status

On this page