Sign API

Document
- Upload documentpost
Dossier
Invite
Archive
Channels
- Get configured channelsget
Invitee
- Update inviteeput
Identification
- Get identificationsget
Payment
- Get paymentsget
Client
Webhook
Branding
- Update brandingpost
- Get brandingget
Reassign Request
Template

Seal API

Seal
- Seal a documentpost

Sign API

Document
- Upload documentpost
Dossier
Invite
Archive
Channels
- Get configured channelsget
Invitee
- Update inviteeput
Identification
- Get identificationsget
Payment
- Get paymentsget
Client
Webhook
Branding
- Update brandingpost
- Get brandingget
Reassign Request
Template

Seal API

Seal
- Seal a documentpost

Create template

post https://api.cm.com/sign/v1/templates

Create a new template.

URL Expired

The URL for this request expired after 30 days.

Body Params

name

string

required

length ≤ 255

Name of the template.

files

array of objects

files

attachments

array of objects

attachments

invitees

array of objects

invitees

fields

array of objects

fields

Responses

Response body

object

uuid

Unique ID of the template.

name

string

Name of the template.

files

array of objects

Files linked to the template.

files

object

uuid

A unique reference number for this file.

name

string

Original name of the file without extension.

attachments

array of objects

Attachments linked to the template.

attachments

object

uuid

A unique reference number for this file.

name

string

Original name of the attachment without extension.

fields

array of objects

Fields that will be linked to the file and invitee when applying to a dossier.

fields

object

type

string

The type of field for the invitee.

signature signatureDate initials text textarea label checkbox radio stamp

required

boolean

Boolean for if the field is required to be filled by the invitee.

value

string

The value of the field, if the type is 'label'.

file

integer

The index of the file when creating the dossier to link this field to, starting from 0.

invitee

integer

The index of the invitee when creating the dossier to link this field to, starting from 0.

locations

array of objects

locations

object

range

string

length ≤ 64

The page number within the PDF that this field occupies (e.g. 1), or range for a initials field (e.g. 1-3).

float

X position of the field in points.

float

Y position of the field in points.

width

float

Width of the field in points.

height

float

Height of the field in points.

lastUsedAt

date-time

The date the template was last applied on a dossier, in ISO 8601 format.

updatedAt

date-time

The date the template was last updated, in ISO 8601 format.

createdAt

date-time

The date the template was created, in ISO 8601 format.

Response body

object

status

number

Response status code, should match HTTP error code

message

string

High level description of the error that occured. This description, when present, can be shown to the end user. It might describe that the system is not available, or that an unexpected error occured. In test mode, the API will return more information (targeted at the developer) here then in production mode.

Response body

object

status

number

Response status code, should match HTTP error code

message

string

Updated 12 months ago

Get all templates

Get template

Did this page help you?

Language

Credentials

Bearer

JWT

URL


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api.cm.com/sign/v1/templates \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Updated 12 months ago

Get all templates

Get template

Did this page help you?

Sign API
Document
Upload documentpost
Dossier
Gets all field valuesget
Get field valueget
Download signed filesget
Delete dossierdelete
Update dossierput
Get dossierget
Create dossierpost
Invite
Delete invitedelete
Get inviteget
Create invitespost
Get all invitesget
Archive
Download fileget
Delete dossierdelete
Get all dossiersget
Channels
Get configured channelsget
Invitee
Update inviteeput
Identification
Get identificationsget
Payment
Get paymentsget
Client
Update clientput
Get clientget
Get all clientsget
Create clientpost
Webhook
Delete webhookdelete
Update webhookput
Get webhookget
Get all webhooksget
Add webhookpost
Branding
Get brandingget
Update brandingpost
Reassign Request
Update reassign requestput
Get reassign requestget
Get all reassign requestsget
Template
Delete templatedelete
Update templateput
Get templateget
Create templatepost
Get all templatesget

Seal API
Seal
Seal a documentpost

Sign API
Document
Upload documentpost
Dossier
Gets all field valuesget
Get field valueget
Download signed filesget
Delete dossierdelete
Update dossierput
Get dossierget
Create dossierpost
Invite
Delete invitedelete
Get inviteget
Create invitespost
Get all invitesget
Archive
Download fileget
Delete dossierdelete
Get all dossiersget
Channels
Get configured channelsget
Invitee
Update inviteeput
Identification
Get identificationsget
Payment
Get paymentsget
Client
Update clientput
Get clientget
Get all clientsget
Create clientpost
Webhook
Delete webhookdelete
Update webhookput
Get webhookget
Get all webhooksget
Add webhookpost
Branding
Get brandingget
Update brandingpost
Reassign Request
Update reassign requestput
Get reassign requestget
Get all reassign requestsget
Template
Delete templatedelete
Update templateput
Get templateget
Create templatepost
Get all templatesget

Seal API
Seal
Seal a documentpost

201The template has been created.

401Unauthorized

404The specified resource was not found