Skip to main content
PUT
Change an Input definition and its options in one call

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.

Path Parameters

id
string<uuid>
required

definition_id

Body

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

Keep until changed. A playbook shows this Input's latest value on or before the date it is read for. Left out, the stored setting stays; a new Input starts at false.

optional
boolean

Optional. A playbook leaves this Input's blank cells out of needs_input. Left out, the stored setting stays; a new Input starts at false.

emphasis
enum<string>

Which change against the previous entry a playbook marks. NUMBER, DECIMAL and PERCENTAGE Inputs only. Left out, the stored setting stays; a new Input starts at none.

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

Options to drop.

Response

The Input definition was saved

success
boolean
input_id
string<uuid>
input
string

The input's name.

created
boolean

True when this call created the input.

data_type
enum<string>
Available options:
PERCENTAGE,
DECIMAL,
NUMBER,
TEXT,
CHOICE
scope
enum<string>
Available options:
PORTFOLIO,
SYMBOL
display_mode
enum<string>
Available options:
TIME_SERIES,
LEVEL_MARKER
chart_role
enum<string> | null
Available options:
OVERLAY,
STANDALONE,
null
description
string | null
carry_forward
boolean

Keep until changed (ADR-136). See InputDefinition.

optional
boolean

Optional (ADR-189). See InputDefinition.

emphasis
enum<string>

Emphasis (ADR-198). See InputDefinition.

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

The options in display order, after this call.

added
string[]
removed
string[]