Skip to main content
New to Corsair? See API access, authentication, and error handling.

Account

get

account.get Read the account name, logo, plan tier and default sending preferences Risk: read
Input: empty object Output

update

account.update Change the account name, logo, time zone, date format or recipient language; only the fields you send are changed Risk: write
Input Output

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
Input Output

get

apiApplications.get Read one API application’s name, callback URLs, owner and branding preferences Risk: read
Input Output

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
Input Output

get

bulkSends.get Read one bulk send with its status and counts of completed and outstanding documents Risk: read
Input Output

getCsvTemplate

bulkSends.getCsvTemplate Get the blank CSV, base64 encoded, whose columns match the given templates Risk: read
Input The template ids go out as repeated template_ids[] parameters, which is how SignWell reads this array. Output

getDocuments

bulkSends.getDocuments List the documents a bulk send created, page by page, with each document’s recipients and status Risk: read
Input Output

list

bulkSends.list List bulk sends page by page, optionally filtered to one user or API application Risk: read
Input Output

validateCsv

bulkSends.validateCsv Check a bulk send CSV against its templates without creating anything, and report what SignWell would change Risk: read
Input Output

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
Input Set draft: true to create without notifying anyone. Without it SignWell sends the request immediately. Each file also needs file_url or file_base64, never both: the schema rejects a call that sends both or neither.
Output

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
Input Supply template_id or template_ids, never both; the schema rejects a call that sends both or neither.
Output

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
Input Deleting cancels any signing in progress and removes the document, its signatures and its audit trail. Output

get

documents.get Read one document with its recipients, status, embedded links and metadata Risk: read
Input Output

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
Input SignWell answers a PDF body by default. This operation asks for url_only and returns file_url, because the plugin cannot hand back binary content intact. Output

getNom151Certificate

documents.getNom151Certificate Get a temporary download URL for the NOM-151 certificate of a completed document, where NOM-151 is enabled Risk: read
Input Output

send

documents.send Send a draft document to its recipients, optionally changing its subject, message and reminders first Risk: destructive
Input A draft created in test mode is still sent live unless test_mode is set again here. The plugin sends it on every send route that accepts it.
Output

sendReminder

documents.sendReminder Remind recipients who have not signed yet, either everyone or a named list, through their own delivery method Risk: destructive
Input
Output

updateAuthentication

documents.updateAuthentication Change or add passcodes for recipients on a sent document; only recipients who have not started signing Risk: write
Input
Output

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
Input Use the recipient ids from documents.get, not the ids you supplied at creation.
Output

Me

get

me.get Read the authenticated user, their role and the account and workspace the API token belongs to Risk: read
Input: empty object Output

Templates

create

templates.create Create a reusable template from files and named placeholders that recipients are filled into later Risk: write
Input
Output

delete

templates.delete Delete a template; documents already created from it are unaffected, but it cannot be used again Risk: destructive · Irreversible
Input Output

get

templates.get Read one template with its placeholders, files and settings Risk: read
Input Output

update

templates.update Change a template’s name, message, placeholders, labels or sending settings Risk: write
Input
Output

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
Input The returned id is the HMAC key for verifying deliveries. Give it to the plugin as webhookSecret, or store it as the account webhook signature. Output

delete

webhooks.delete Delete a registered webhook; SignWell stops posting to its URL immediately Risk: destructive · Irreversible
Input Output

list

webhooks.list List the webhooks registered on the account with their ids and callback URLs Risk: read
Input: empty object Output