Skip to main content
POST
Create plan definition

Authorizations

x-api-key
string
header
required

Your ClinikAPI secret key (clk_live_* or clk_test_*)

Body

application/json
status
enum<string>
required
Available options:
draft,
active,
retired
name
string
Maximum string length: 500
title
string
Maximum string length: 500
type
string
Maximum string length: 200
description
string
Maximum string length: 5000
purpose
string
Maximum string length: 5000
usage
string
Maximum string length: 5000
publisher
string
Maximum string length: 500
date
string
Maximum string length: 30
version
string
Maximum string length: 100
url
string
Maximum string length: 2000
experimental
boolean
topic
string[]
Maximum array length: 10
Maximum string length: 200
goal
object[]
Maximum array length: 20
action
object[]
Maximum array length: 50

Response

201

Plan definition created