Uptick

Supported Formats

application/json

Returns

Response - No Content

Code 204 - application/json

type

string

required

The type of the segment

Must be one of: heading.

data

hash

required

Arbitrary data echoed onto the rendered element as data-* attributes

Must be a Hash

name

string

required

The name of the segment (rendered as data-ppx-name)

Must be a String

attributes

hash

required

Style attributes of the segment

Must be a Hash

attributes.level

string

required

Heading level (renders h1–h6); defaults to 1

Must be one of: 1, 2, 3, 4, 5, 6.

attributes.display

string

required

Display mode (auto renders as flex)

Must be one of: none, auto, block, inline_block.

attributes.color

string

required

Text color — named token (white, lightergray, lightgray, gray, darkgray, black) or any hex / rgb value

Must be a String

attributes.size

string

required

Font size token

Must be one of: 2x-small, x-small, small, medium, large, x-large, 2x-large, 3x-large, 4x-large.

attributes.text_align

string

required

Horizontal text alignment

Must be one of: left, center, right.

attributes.underline

boolean

required

Underline the text

Must be one of: true, false, 1, 0.

attributes.appearance

string

required

Muted text treatment for secondary copy

Must be one of: subdued, monochrome.

children

array

required

Child segments (the heading text, usually text runs)

Must be an array of any type

Events

Feedbacks

Flows

Items

Offers

Segments

Supported Formats

Returns

Response - No Content