Skip to main content
POST
Create an Input (tracked-value) definition

Authorizations

x-api-key
string
header
required

Raw API key shown once when created in the Allocait app (Settings > API keys). Send it verbatim in this header; the server stores and compares only its SHA-256 hash. Allocait generates every key: alc_ followed by 64 lowercase hex characters. Keys issued before 2026-10-10 are 64 hex characters with no prefix and keep working. A key may carry an expiry (90 days or 1 year, or never). A malformed, unknown, revoked or expired key gets 401 with no further detail, and a malformed one is refused before any lookup. Keys cannot be created through this API.

Body

application/json
name
string
required
data_type
enum<string>
required
Available options:
PERCENTAGE,
DECIMAL,
NUMBER,
TEXT,
CHOICE
display_mode
enum<string>
default:TIME_SERIES
Available options:
TIME_SERIES,
LEVEL_MARKER
description
string | null
color
string | null
scope
enum<string>
default:PORTFOLIO
Available options:
PORTFOLIO,
SYMBOL
chart_role
enum<string>
default:STANDALONE
Available options:
OVERLAY,
STANDALONE
carry_forward
boolean
default:false

Keep until changed. A playbook shows this Input's latest value on or before the date it is read for.

optional
boolean
default:false

Optional. A playbook leaves this Input's blank cells out of needs_input.

emphasis
enum<string>
default:none

Which change against the previous entry a playbook marks. NUMBER, DECIMAL and PERCENTAGE Inputs only.

Available options:
none,
lower,
higher,
not_higher,
not_lower
options
string[]

A CHOICE input's options, in display order.

Response

The Input definition was created. With options, the response is the InputSaveResponse shape that PUT /inputs/{id} returns.

success
boolean
definition_id
string<uuid>
definition
object

The full Input definition record, as returned by create/update (distinct field names from the InputDefinition list-view above; id, not input_definition_id).