PATCH
/
api
/
v1
/
public
/
template
/
{template_id}
/
publish
{
  "data": {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "string",
      "description": "string",
      "variables": [
        {
          "name": "string",
          "defaultValue": "string"
        }
      ],
      "tags": [
        "string"
      ],
      "draftVersion": {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "version": 0,
        "status": "PUBLISHED_LATEST",
        "publishedAt": "2024-08-30T07:39:49.292Z"
      },
      "publishedVersion": {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "version": 0,
        "status": "PUBLISHED_LATEST",
        "publishedAt": "2024-08-30T07:39:49.292Z"
      },
      "templateVersions": [
        {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "version": 0,
          "status": "PUBLISHED_LATEST",
          "publishedAt": "2024-08-30T07:39:49.292Z"
        }
      ]
  },
  "error": null,
  "errors": null,
  "meta": null
}
​
Authorization
string
required
Bearer token for API authentication. Format: Bearer {{apiToken}}

​
Parameters

​
template_id
UUID
required
The ID of the template to publish.

​
Response

​
data
object
​
id
UUID
Template ID.
​
name
string
Template name.
​
description
string
Template description.
​
variables
array
List of template variables.
​
name
string
Variable name.
​
defaultValue
string
Default value for the variable.
​
tags
array
List of template tags.
​
draftVersion
object
Draft version details.
​
id
UUID
Version ID.
​
version
integer
Version number.
​
status
string
Version status (e.g., “PUBLISHED_LATEST”).
​
publishedAt
datetime
Timestamp of when the version was published.
​
publishedVersion
object
Published version details.
​
id
UUID
Version ID.
​
version
integer
Version number.
​
status
string
Version status (e.g., “PUBLISHED_LATEST”).
​
publishedAt
datetime
Timestamp of when the version was published.
​
templateVersions
array
List of all template versions.
​
id
UUID
Version ID.
​
version
integer
Version number.
​
status
string
Version status (e.g., “PUBLISHED_LATEST”).
​
publishedAt
datetime
Timestamp of when the version was published.
​
error
object
​
errorCode
string
The error code (e.g., BAD_REQUEST).
​
message
string
A human-readable error message.
{
  "data": {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "string",
      "description": "string",
      "variables": [
        {
          "name": "string",
          "defaultValue": "string"
        }
      ],
      "tags": [
        "string"
      ],
      "draftVersion": {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "version": 0,
        "status": "PUBLISHED_LATEST",
        "publishedAt": "2024-08-30T07:39:49.292Z"
      },
      "publishedVersion": {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "version": 0,
        "status": "PUBLISHED_LATEST",
        "publishedAt": "2024-08-30T07:39:49.292Z"
      },
      "templateVersions": [
        {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "version": 0,
          "status": "PUBLISHED_LATEST",
          "publishedAt": "2024-08-30T07:39:49.292Z"
        }
      ]
  },
  "error": null,
  "errors": null,
  "meta": null
}

​
Status Codes

  • 200 - OK
  • 400 - BAD REQUEST
  • 401 - UNAUTHORISED
  • 404 - NOT FOUND