Templates

Replace a template

Full-replaces metadata, roles, and fields. Pass the expected version in If-Match or body.version. Matching role keys and field names preserve public ids.

put/templates/{templateId}

Request

  • Base URL: https://inkseal.net/api/v1
  • URL: https://inkseal.net/api/v1/templates/{templateId}
  • Auth: HTTP bearer

Headers

If-Matchstring

Expected integer template version.

Request body

versioninteger
namestring required
descriptionstring nullable
signingOrder'parallel' | 'sequential'
defaultSubjectstring nullable
defaultMessagestring nullable
defaultExpiresInDaysinteger
emailVerificationboolean

Example request

{
  "fields": [
    {
      "type": "signature"
    }
  ]
}

Response

The replaced template.

Example response

{
  "data": {
    "fields": [
      {
        "type": "signature"
      }
    ]
  }
}

Changes

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