templates

Create a template

Creates a reusable template from a file you have already uploaded with POST /files.

A template stores a document together with its signature fields, so a later POST /docs (or POST /docs/drafts) with templateId only has to supply the recipients.

Requirements

  • fileId is required.
  • signeeDetails must contain at least one field.
  • Contact details on a field are optional. Store them to pre-fill a recurring counterparty, or leave them out and supply them per document.

Requires the templates capability. Check GET /account/capabilities.

post/templates

Request

  • Base URL: https://docs-api.formify.eu/v1
  • URL: https://docs-api.formify.eu/v1/templates
  • Auth: OAuth 2 (authorization code, authorization URL https://docs-api.formify.eu/v1/oauth/authorize, token URL https://docs-api.formify.eu/v1/oauth/token, scopes: write)

Request body

fileIdstring uuid required

File ID from POST /files

namestring

Name of the template

sharingSetting'private' | 'shared'

private (default) — only you can use and manage the template. shared — everyone on the account can. Requires the accessLevels capability.

enableSigningOrderboolean

Store a sequential signing order on the template. Requires the signingOrder capability.

errorLanguage'en' | 'sv' | 'es'

Language for error messages

Example request

{
  "signeeDetails": [
    {
      "fullName": "Buyer",
      "signatureType": "digital_ink",
      "signaturePlacement": "existing",
      "signatureBox": {
        "page": 0,
        "x": 72,
        "y": 560,
        "scale": 1
      },
      "signingOrder": 1
    }
  ]
}

Response

Template created successfully

templateIdstring uuid

Unique identifier of the template

namestring

Name of the template

createdAtstring date-time

Template creation timestamp

userIdstring uuid

User ID of the template owner

sharingSetting'shared' | 'private'

Who on the account may use and manage the template

Changes

No recorded changes to this operation across all 1 revision of this API.