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

BoldSign Template API

The Template API from BoldSign — 16 operation(s) for template.

BoldSign Template API is one of 11 APIs that BoldSign 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 16 operations across 16 paths, and defines 63 schemas. It is described by OpenAPI 3.0.3, at version 1.

Requests are made against 4 base URLs: https://api.boldsign.com, https://eu.boldsign.com, https://ca.boldsign.com, https://au.boldsign.com.

16 operations 16 paths 63 schemas 2 DELETE3 GET2 PATCH8 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1
Base URL
https://api.boldsign.com
Authentication
API Key, API Key
Terms of Service
Resource Areas
1

Authentication & Security 2

BoldSign Template API declares 2 security schemes for authenticating requests. An API key is passed in the header as Authorization (Bearer). An API key is passed in the header as X-API-KEY (X-API-KEY). By default, every request must be authenticated.

  • Bearer — Format 'Bearer' [space] [TOKEN]. Ex: 'Bearer eyJhbGciOiJIUzI1N'
  • X-API-KEY — Format [API-KEY]. Ex: 'abcdef12345'

Paths & Operations 16

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

Template 16
GET
/v1/template/list
List all the templates.
ListTemplates 11 params → 200401
POST
/v1/template/create
Creates a new template.
CreateTemplate body → 201401403422
POST
/v1/template/createEmbeddedTemplateUrl
Generates a create URL to embeds template create process into your application.
CreateEmbeddedTemplateUrl body → 201401422
POST
/v1/template/getEmbeddedTemplateEditUrl
Generates a edit URL to embeds template edit process into your application.
getEmbeddedTemplateEditUrl 1 param body → 201400401
DELETE
/v1/template/delete
Deletes a template.
DeleteTemplate 2 params → 204401403
POST
/v1/template/send
Send a document for signature using a Template.
SendUsingTemplate 1 param body → 201401422
POST
/v1/template/mergeAndSend
Send the document by merging multiple templates.
MergeAndSend body → 201422401
POST
/v1/template/createEmbeddedRequestUrl
Generates a send URL using a template which embeds document sending process into your application.
CreateEmbeddedRequestUrlTemplate 1 param body → 201422401
POST
/v1/template/mergeCreateEmbeddedRequestUrl
Generates a merge request URL using a template that combines document merging and sending processes into your application.
MergeCreateEmbeddedRequestUrlTemplate body → 201422401
GET
/v1/template/properties
Get summary of the template.
GetTemplateProperties 1 param → 200401403
GET
/v1/template/download
Download the template.
Download 3 params → 200401400
PUT
/v1/template/edit
Edit and updates an existing template.
EditTemplate 1 param body → 204400422401
PATCH
/v1/template/addTags
Add the Tags in Templates.
AddTemplateTag body → 200400401
DELETE
/v1/template/deleteTags
Delete the Tags in Templates.
DeleteTemplateTag body → 200401400
PATCH
/v1/template/share
Share a template with teams and manage permissions.
ShareTemplate 1 param body → 200400403500401
POST
/v1/template/createEmbeddedPreviewUrl
Generates a preview URL for a template to view it.
createEmbeddedPreviewUrl 1 param body → 200401

Schemas 63

The contract defines 63 schemas that model the data the API accepts and returns. The most detailed are EmbeddedMergeTemplateFormRequest (50 properties), EmbeddedSendTemplateFormRequest (47 properties), FormField (43 properties), TemplateFormFields (43 properties). Each schema is shown below with its type and property counts.

FormulaFieldSettings
object
2 properties
TextTagOffset
object
2 properties
PageDetails
object
6 properties
DocumentCC
object
1 property 1 required
FormField
object
43 properties 3 required
Template
object
19 properties
AuthenticationSettings
object
1 property
EmbeddedTemplateCreated
object
2 properties
TemplateFormFields
object
43 properties
TemplateSenderDetail
object
2 properties
Rectangle
object
4 properties
TemplateSharing
object
1 property
TemplateCC
object
2 properties
ReminderSettings
object
3 properties
TemplateRole
object
20 properties 1 required
PhoneNumber
object
2 properties
EmbeddedSendTemplateFormRequest
object
47 properties
CreateTemplateRequest
object
30 properties 1 required
TemplateSenderDetails
object
3 properties
TemplateProperties
object
33 properties
AttachmentInfo
object
4 properties 2 required
ConditionalRule
object
3 properties
EmbeddedTemplatePreviewJsonRequest
object
2 properties
ExistingFormField
object
5 properties
ErrorResponse
object
2 properties
EmbeddedTemplateEdited
object
1 property
DocumentCreated
object
1 property
EmbeddedMergeTemplateFormRequest
object
50 properties
TemplateCreated
object
1 property
TemplateShareRequest
object
1 property
Roles
object
26 properties
TemplateGroupSigner
object
2 properties
SendForSignFromTemplateForm
object
37 properties
CollaborationSettings
object
4 properties
TemplateTeamShareRequest
object
3 properties 2 required
TemplateSharedTemplateDetail
object
2 properties
EmbeddedTemplateEditRequest
object
11 properties
TemplateFiles
object
4 properties
MergeAndSendForSignForm
object
40 properties
Font
object
8 properties
IdentityVerificationSettings
object
7 properties
EmbeddedTemplatePreview
object
1 property
EditTemplateRequest
object
25 properties
TemplateShareErrorResponse
object
4 properties
ImageInfo
object
3 properties 2 required
FormFieldPermission
object
3 properties
TemplateRecords
object
2 properties
BehalfOf
object
2 properties
Validation
object
3 properties 1 required
Role
object
25 properties
DocumentInfo
object
4 properties 2 required
ErrorResult
object
1 property
TemplateSignerDetails
object
19 properties
TextTagDefinition
object
33 properties 3 required
TemplateTeamShare
object
2 properties
EmbeddedCreateTemplateRequest
object
41 properties 1 required
RecipientNotificationSettings
object
12 properties
TemplateTag
object
4 properties 1 required
GroupSignerSettings
object
2 properties
Size
object
2 properties
EmbeddedSendCreated
object
2 properties
FormGroup
object
5 properties 2 required
EditableDateFieldSettings
object
4 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

boldsign-template-api-openapi.yml Raw ↑

Other APIs BoldSign publishes across the network.

BoldSign Branding API
BoldSign Contacts API
BoldSign Custom Field API
BoldSign Document API
BoldSign GroupContacts API
BoldSign Identity Verification API
BoldSign Plan API
BoldSign Sender Identities API
BoldSign Teams API
BoldSign User API
Where this information came from

This is an independent, third-party profile of BoldSign 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.