create template

post

https://{defaultHost}/templates

The response type is not supported yet, or validation failed (e.g. a duplicate name).

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

The template to create

Request body for creating a template. response_type picks what is created: a fact template for the detail types, an assessment type for choice.

response_type

string

enum

required

The kind of fact the template captures. Coming soon: multistep, calculated, link_with_status, quadrant, stakeholder.

Allowed:

name

string

required

The template name, unique within the workspace.

definition

string

required

What the template captures.

template_group_id

uuid

The Fact Group to file the template in. Defaults to the workspace's default group for the response type.

justification

string

enum

Whether a justification is optional, available, or required alongside each fact. Defaults to none.

Allowed:

applicable_topic_types

array of strings

The topic types the template applies to, as plural API names (e.g. "capabilities"). A type not enabled in the workspace is accepted with a warning.

applicable_topic_types

priority

string

enum

Whether a Fact Card must, should, or may carry this fact. Defaults to optional.

Allowed:

review_days

integer

How many days a fact stays trusted before review. Defaults to 365.

lifecycle

string

enum

How the fact behaves over its review period. Defaults to trusted.

Allowed:

options

array of objects

For choice templates, the answers to choose from, in display order. On update, an option with an id edits that option and one without is added; options cannot be removed through the API.

options

Responses

Language

Credentials

Bearer

Token

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201created

401Unauthorized

422unprocessable entity