Sign in
Start free7-day free trial
Live API contract
API REFERENCE / Templates

Publish a template version

POST/v1/templates/{id}/publish

Publishes the current draft as a new version. Versions are immutable and waivers keep pointing at the version they were signed under, so publishing never rewrites history. 409 for an archived template: unarchive it first, so that restoring a retired document is a deliberate, separately recorded act.

Authentication

Send an organization-scoped API key in the Authorization header. Keep credentials on your server.

templates:manage
Authentication and API keys →

Parameters

idpathrequired
string · uuid

Responses

200 Response schema

application/json

versionIdstring · uuidrequired
versionNumberintegerrequired

Range: -9007199254740991 to 9007199254740991.

publishedAtstring · date-timerequired
View complete response schema
HTTP 200 schema
{
  "type": "object",
  "properties": {
    "versionId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
    },
    "versionNumber": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "publishedAt": {
      "type": "string",
      "format": "date-time"
    }
  },
  "required": [
    "versionId",
    "versionNumber",
    "publishedAt"
  ],
  "additionalProperties": false
}

401 Response schema

application/json

errorobjectrequired
View nested fields
codestringrequired
messagestringrequired
requestIdstringrequired
detailsvalue
View complete response schema
HTTP 401 schema
{
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": "string"
        },
        "message": {
          "type": "string"
        },
        "requestId": {
          "type": "string"
        },
        "details": {}
      },
      "required": [
        "code",
        "message",
        "requestId"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "error"
  ],
  "additionalProperties": false
}

403 Response schema

application/json

errorobjectrequired
View nested fields
codestringrequired
messagestringrequired
requestIdstringrequired
detailsvalue
View complete response schema
HTTP 403 schema
{
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": "string"
        },
        "message": {
          "type": "string"
        },
        "requestId": {
          "type": "string"
        },
        "details": {}
      },
      "required": [
        "code",
        "message",
        "requestId"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "error"
  ],
  "additionalProperties": false
}

404 Response schema

application/json

errorobjectrequired
View nested fields
codestringrequired
messagestringrequired
requestIdstringrequired
detailsvalue
View complete response schema
HTTP 404 schema
{
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": "string"
        },
        "message": {
          "type": "string"
        },
        "requestId": {
          "type": "string"
        },
        "details": {}
      },
      "required": [
        "code",
        "message",
        "requestId"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "error"
  ],
  "additionalProperties": false
}

409 Response schema

application/json

errorobjectrequired
View nested fields
codestringrequired
messagestringrequired
requestIdstringrequired
detailsvalue
View complete response schema
HTTP 409 schema
{
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": "string"
        },
        "message": {
          "type": "string"
        },
        "requestId": {
          "type": "string"
        },
        "details": {}
      },
      "required": [
        "code",
        "message",
        "requestId"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "error"
  ],
  "additionalProperties": false
}

422 Response schema

application/json

errorobjectrequired
View nested fields
codestringrequired
messagestringrequired
requestIdstringrequired
detailsvalue
View complete response schema
HTTP 422 schema
{
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": "string"
        },
        "message": {
          "type": "string"
        },
        "requestId": {
          "type": "string"
        },
        "details": {}
      },
      "required": [
        "code",
        "message",
        "requestId"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "error"
  ],
  "additionalProperties": false
}

429 Response schema

application/json

errorobjectrequired
View nested fields
codestringrequired
messagestringrequired
requestIdstringrequired
detailsvalue
View complete response schema
HTTP 429 schema
{
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": "string"
        },
        "message": {
          "type": "string"
        },
        "requestId": {
          "type": "string"
        },
        "details": {}
      },
      "required": [
        "code",
        "message",
        "requestId"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "error"
  ],
  "additionalProperties": false
}

Authentication and validation failures use the shared error envelope. Save the request ID when diagnosing a failed call.

Build the surrounding workflow

Read the templates guide for ordering, verification and recovery. Browse the other templates endpoints when you need the next operation.