templates

Update a template

Replaces the template's configuration. Send the whole configuration — anything omitted is lost, except fileId, which keeps the template's current document when omitted.

Documents already created from this template are unaffected: they took a copy at creation time.

Owner only. A colleague can use and read a shared template but not edit it.

put/templates/{templateId}

Request

  • Base URL: https://docs-api.formify.eu/v1
  • URL: https://docs-api.formify.eu/v1/templates/{templateId}
  • 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)

Path parameters

templateIdstring uuid required

The unique identifier of the template.

Request body

fileIdstring uuid

File ID from POST /files. Omit to keep the template's current document.

namestring

Name of the template. Omit to keep the current name.

sharingSetting'private' | 'shared'

See CreateTemplateRequest.sharingSetting.

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 updated 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.