Templates

Create a template

Claims one ready, unused document and stores its reusable role and field layout atomically. Honors Idempotency-Key and durably replays the exact original creation response.

post/templates

Request

Base URL: https://inkseal.net/api/v1
URL: https://inkseal.net/api/v1/templates
Auth: HTTP bearer

Headers

Idempotency-Keystring

Makes this mutation retry-safe. 1 to 255 printable ASCII characters (0x20 to 0x7e), trimmed before use. The key is scoped to the workspace and the credential that sent it. Reusing it with a different method, path, or payload answers 422 idempotency_key_reuse. A completed attempt replays its stored status and body with an Idempotent-Replay: true response header; 5xx, 429, and non-JSON answers leave the key retryable. A concurrent request holding the 90 second lease answers 409 idempotency_in_progress. Records are retained 24 hours.

Request body

documentIdstring required

namestring required

descriptionstring nullable

signingOrder'parallel' | 'sequential'

defaultSubjectstring nullable

defaultMessagestring nullable

defaultExpiresInDaysinteger

emailVerificationboolean

Example request

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

Response

The created template.

Example response

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

Changes

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