Account
get
account.get
Read the account name, logo, plan tier and default sending preferences
Risk: read
preferences full type
preferences full type
update
account.update
Change the account name, logo, time zone, date format or recipient language; only the fields you send are changed
Risk: write
preferences full type
preferences full type
Api Applications
delete
apiApplications.delete
Delete an API application; documents and templates that reference it keep their data but lose its branding and settings
Risk: destructive · Irreversible
get
apiApplications.get
Read one API application’s name, callback URLs, owner and branding preferences
Risk: read
owner full type
owner full type
preferences full type
preferences full type
Bulk Sends
create
bulkSends.create
Create a bulk send from a CSV of recipient rows against one or more templates; each row becomes a document and is sent
Risk: destructive
get
bulkSends.get
Read one bulk send with its status and counts of completed and outstanding documents
Risk: read
templates full type
templates full type
getCsvTemplate
bulkSends.getCsvTemplate
Get the blank CSV, base64 encoded, whose columns match the given templates
Risk: read
getDocuments
bulkSends.getDocuments
List the documents a bulk send created, page by page, with each document’s recipients and status
Risk: read
documents full type
documents full type
list
bulkSends.list
List bulk sends page by page, optionally filtered to one user or API application
Risk: read
bulk_sends full type
bulk_sends full type
validateCsv
bulkSends.validateCsv
Check a bulk send CSV against its templates without creating anything, and report what SignWell would change
Risk: read
Documents
create
documents.create
Create a document from one or more files and send it for signature unless draft is true; this notifies real recipients
Risk: destructive
files full type
files full type
recipients full type
recipients full type
labels full type
labels full type
attachment_requests full type
attachment_requests full type
conditional_rules full type
conditional_rules full type
fields full type
fields full type
copied_contacts full type
copied_contacts full type
recipients full type
recipients full type
embedded full type
embedded full type
files full type
files full type
copied_contacts full type
copied_contacts full type
labels full type
labels full type
createFromTemplate
documents.createFromTemplate
Create a document from one or several templates, filling each placeholder with a recipient, and send it unless draft is true
Risk: destructive
recipients full type
recipients full type
copied_contacts full type
copied_contacts full type
labels full type
labels full type
files full type
files full type
template_fields full type
template_fields full type
recipients full type
recipients full type
embedded full type
embedded full type
files full type
files full type
copied_contacts full type
copied_contacts full type
labels full type
labels full type
delete
documents.delete
Delete a document and cancel any signing in progress; the document, its signatures and its audit trail are gone
Risk: destructive · Irreversible
get
documents.get
Read one document with its recipients, status, embedded links and metadata
Risk: read
recipients full type
recipients full type
embedded full type
embedded full type
files full type
files full type
copied_contacts full type
copied_contacts full type
labels full type
labels full type
getCompletedPdf
documents.getCompletedPdf
Get a temporary download URL for a completed document as a PDF or a ZIP; the file itself is not returned
Risk: read
getNom151Certificate
documents.getNom151Certificate
Get a temporary download URL for the NOM-151 certificate of a completed document, where NOM-151 is enabled
Risk: read
send
documents.send
Send a draft document to its recipients, optionally changing its subject, message and reminders first
Risk: destructive
labels full type
labels full type
attachment_requests full type
attachment_requests full type
copied_contacts full type
copied_contacts full type
fields full type
fields full type
recipients full type
recipients full type
embedded full type
embedded full type
files full type
files full type
copied_contacts full type
copied_contacts full type
labels full type
labels full type
sendReminder
documents.sendReminder
Remind recipients who have not signed yet, either everyone or a named list, through their own delivery method
Risk: destructive
recipients full type
recipients full type
recipients full type
recipients full type
updateAuthentication
documents.updateAuthentication
Change or add passcodes for recipients on a sent document; only recipients who have not started signing
Risk: write
recipients full type
recipients full type
recipients full type
recipients full type
embedded full type
embedded full type
files full type
files full type
copied_contacts full type
copied_contacts full type
labels full type
labels full type
updateRecipients
documents.updateRecipients
Change the name or email of recipients on a document that has been sent, which emails the updated recipients; only recipients who have not started signing
Risk: destructive
recipients full type
recipients full type
recipients full type
recipients full type
embedded full type
embedded full type
files full type
files full type
copied_contacts full type
copied_contacts full type
labels full type
labels full type
Me
get
me.get
Read the authenticated user, their role and the account and workspace the API token belongs to
Risk: read
user full type
user full type
account full type
account full type
workspace full type
workspace full type
contact full type
contact full type
Templates
create
templates.create
Create a reusable template from files and named placeholders that recipients are filled into later
Risk: write
files full type
files full type
placeholders full type
placeholders full type
copied_placeholders full type
copied_placeholders full type
labels full type
labels full type
attachment_requests full type
attachment_requests full type
conditional_rules full type
conditional_rules full type
fields full type
fields full type
files full type
files full type
labels full type
labels full type
delete
templates.delete
Delete a template; documents already created from it are unaffected, but it cannot be used again
Risk: destructive · Irreversible
get
templates.get
Read one template with its placeholders, files and settings
Risk: read
files full type
files full type
labels full type
labels full type
update
templates.update
Change a template’s name, message, placeholders, labels or sending settings
Risk: write
labels full type
labels full type
placeholders full type
placeholders full type
copied_placeholders full type
copied_placeholders full type
fields full type
fields full type
files full type
files full type
labels full type
labels full type
Webhooks
create
webhooks.create
Register a callback URL that SignWell posts document events to; the returned id is the HMAC key for verifying deliveries
Risk: write
delete
webhooks.delete
Delete a registered webhook; SignWell stops posting to its URL immediately
Risk: destructive · Irreversible
list
webhooks.list
List the webhooks registered on the account with their ids and callback URLs
Risk: read
webhooks full type
webhooks full type