How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

SignWell Template API

Create and manage reusable document templates.

SignWell Template API is one of 7 APIs that SignWell publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 1 JSON Schema definition.

Tagged areas include Template. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 1 JSON Schema.

This API exposes 5 operations across 2 paths, and defines 28 schemas. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against a single base URL, https://www.signwell.com.

5 operations 2 paths 28 schemas 1 DELETE2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v1
Base URL
https://www.signwell.com/api/v1
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

SignWell Template API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-Api-Key (api_key).

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Template 5

Create and manage reusable document templates.

GET
/api/v1/document_templates
List Templates
listTemplates 2 params → 200401429
POST
/api/v1/document_templates
Create Template
createTemplate body → 201400422429
GET
/api/v1/document_templates/{id}
Get Template
getTemplate 1 param → 200404429
PUT
/api/v1/document_templates/{id}
Update Template
updateTemplate 1 param body → 200400422429
DELETE
/api/v1/document_templates/{id}
Delete Template
deleteTemplate 1 param → 204404429

Schemas 28

The contract defines 28 schemas that model the data the API accepts and returns. The most detailed are DocumentTemplateResponse (30 properties), DocumentTemplateRequest (22 properties), DocumentTemplateUpdateRequest (15 properties), CheckboxGroupInfo (9 properties). Each schema is shown below with its type and property counts.

Page
integer
The page number for pagination. Defaults to the first page.
DocumentTemplateUpdateRequest
object
15 properties
Files
array
Document files can be uploaded by specifying a file URL or base64 string. Either fileurl or filebase64 must be present (not both). Valid file types are: .pdf,…
FileInfo
object
File information
2 properties 2 required
TemplateFields
array
Document fields placed on a document for collecting data or signatures from recipients. At least one field must be present in the Create Document request if dr…
DropdownOption
A dropdown option - either a simple string or a detailed object with name and optional apiid
LabelsUpdate
array
Labels can be used to organize documents in a way that can make it easy to find using the document search in SignWell. A document can have multiple labels. Upd…
DocumentTemplateRequest
object
22 properties 2 required
Labels
array
Labels can be used to organize documents in a way that can make it easy to find using the document search in SignWell. A document can have multiple labels.
CheckboxGroupInfo
object
Checkbox group configuration
9 properties 3 required
FieldType
string
Type of signing field
TemplateAttachmentRequests
array
Attachments that a recipient must upload to complete the signing process. Attachment requests are shown after all document fields have been completed.
CheckboxValidation
string
Validation rule for checkbox groups
AttachmentRequestInfo
object
Attachment request information
3 properties 2 required
ValidationErrorResponse
object
Validation error response. The errors object contains field-specific error details with dynamic keys.
1 property 1 required
RateLimitErrorResponse
object
Rate limit exceeded error response (HTTP 429)
1 property 1 required
TextValidation
string
Validation rule for text fields
Limit
integer
The number of documents to fetch. Defaults to 10, max is 50.
Placeholders
array
Placeholders are generally job roles that must complete and/or sign the document. For example, a placeholder might be “Client” or “Legal Department”. When a do…
DocumentTemplateListResponse
object
List of templates with pagination
6 properties 4 required
DocumentTemplateResponse
object
30 properties 1 required
LabelRequest
object
Labels can be used to organize documents and templates in a way that can make it easy to find using the document search/template search in SignWell. Labels can…
1 property 1 required
DateFormat
string
Date format for date fields. Valid values: MM/DD/YYYY, DD/MM/YYYY, YYYY/MM/DD, Month DD, YYYY, MM/DD/YYYY hh:mm:ss a. Default: MM/DD/YYYY
CopiedPlaceholders
array
Copied placeholders are emailed the final document once it has been completed by all recipients.
LabelInfo
object
Label information
2 properties
TemplateId
string
Unique identifier for a template.
ErrorResponse
object
Standard error response
2 properties
TemplateCheckboxGroups
array
Checkbox fields that are placed on a document can be grouped with selection requirements. At least 2 checkbox fields in an array of fields must be assigned to…

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

signwell-template-api-openapi.yml Raw ↑

Other APIs SignWell publishes across the network.

SignWell API Application API
SignWell Bulk Send API
SignWell Document API
SignWell Me API
SignWell Regional API
SignWell Webhooks API
Where this information came from

This is an independent, third-party profile of SignWell Template API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.