$goSign
Updated on Aug 27, 2025 5 minutes to readThe GoSign Plugin is based on the GoSign API, which provides tools to create and manage electronic signature packages, recipients, documents, fields, and notifications. Full documentation and an interactive playground for testing requests are available at GoSign API Developers.
Methods
| Method | Description |
|---|---|
| autoPlaceFields | Automatically places multiple fields for a recipient in a document. |
| createDocument | Creates a new document in a package. |
| createField | Creates a new field in a package. |
| createFields | Creates multiple fields in a package. |
| createPackage | Creates a new package. |
| createRecipient | Creates a new recipient in a package. |
| createRecipients | Creates multiple recipients in a package. |
| deleteDocument | Deletes a document from a package. |
| deleteField | Deletes a field from a package. |
| deletePackage | Deletes a package. |
| deleteRecipient | Deletes a recipient from a package. |
| downloadCertificate | Downloads the certificate of a completed package. |
| downloadDocument | Downloads a document from a package. |
| getActivityRecords | Retrieves activity records for a package. |
| getDocument | Retrieves a document from a package. |
| getDocuments | Retrieves all documents in a package. |
| getField | Retrieves a field from a package. |
| getFields | Retrieves all fields in a package. |
| getNotificationSettings | Retrieves notification settings for a package. |
| getPackage | Retrieves a package with optional details. |
| getRecipient | Retrieves a recipient from a package. |
| getRecipients | Retrieves all recipients from a package. |
| restorePackage | Restores a previously deleted package. |
| sendPackage | Sends a package for signing. |
| shareFields | Shares the fields of a package and returns a URL. |
| updateField | Updates a field in a package. |
| updateFields | Updates multiple fields in a package. |
| updatePackage | Updates a package's data. |
| updateRecipient | Updates a recipient in a package. |
| updateRecipients | Updates multiple recipients in a package. |
| updateNotificationSettings | Updates notification settings for a package. |
| voidPackage | Voids a package, preventing further signing. |
Methods Details
autoPlaceFields()
• Type
(client: string, pkgId: string, rcptId: string, docId: string, data: Array<object>) => objectcreateDocument()
• Type
(client: string, pkgId: string, fileId: string) => objectcreateField()
• Type
(client: string, pkgId: string, data: object) => objectcreateFields()
• Type
(client: string, pkgId: string, data: Array<object>) => objectcreatePackage()
• Type
(client: string, data: object) => objectcreateRecipient()
• Type
(client: string, pkgId: string, data: object) => objectcreateRecipients()
• Type
(client: string, pkgId: string, data: Array<object>) => objectdeleteDocument()
• Type
(client: string, pkgId: string, id: string) => objectdeleteField()
• Type
(client: string, pkgId: string, id: string) => objectdeletePackage()
• Type
(client: string, pkgId: string) => objectdeleteRecipient()
• Type
(client: string, pkgId: string, id: string) => objectdownloadCertificate()
• Type
(client: string, pkgId: string) => objectdownloadDocument()
• Type
(client: string, pkgId: string, id: string) => objectgetActivityRecords()
• Type
(client: string, pkgId: string) => objectgetDocument()
• Type
(client: string, pkgId: string, id: string) => objectgetDocuments()
• Type
(client: string, pkgId: string) => Array<object>getField()
• Type
(client: string, pkgId: string, id: string) => objectgetFields()
• Type
(client: string, pkgId: string) => objectgetNotificationSettings()
• Type
(client: string, pkgId: string) => objectgetPackage()
• Type
(client: string, pkgId: string, params?: GoSignGetPackageParams) => objectgetRecipient()
• Type
(client: string, pkgId: string, id: string) => objectgetRecipients()
• Type
(client: string, pkgId: string) => objectrestorePackage()
• Type
(client: string, pkgId: string) => objectsendPackage()
• Type
(client: string, pkgId: string) => objectshareFields()
• Type
(client: string, pkgId: string) => { url: string }updateField()
• Type
(client: string, pkgId: string, data: object) => objectupdateFields()
• Type
(client: string, pkgId: string, data: Array<object>) => objectupdatePackage()
• Type
(client: string, data: object) => objectupdateRecipient()
• Type
(client: string, pkgId: string, data: object) => objectupdateRecipients()
• Type
(client: string, pkgId: string, data: Array<object>) => objectupdateNotificationSettings()
• Type
(client: string, pkgId: string, data: object) => objectvoidPackage()
• Type
(client: string, pkgId: string) => object