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: modal.

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

Attributes of the segment

Must be a Hash

children

array

required

Child segments rendered inside the modal panel

Must be an array of any type

Supported Formats

application/json

Returns

Response - No Content

Code 204 - application/json

type

string

required

The type of the segment

Must be one of: view.

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.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.

attributes.padding

array

required

A spacing token: x-tight, tight, normal, loose, x-loose, 2x-loose, 3x-loose, or an array [all] / [vertical, horizontal] / [top, right, bottom, left]; “none” for no padding

Must be an array of any type

attributes.margin_top

string

required

A spacing token: x-tight, tight, normal, loose, x-loose, 2x-loose, 3x-loose, optionally negated with a leading - (e.g. -tight)

Must be a String

attributes.margin_right

string

required

See margin_top

Must be a String

attributes.margin_bottom

string

required

See margin_top

Must be a String

attributes.margin_left

string

required

See margin_top

Must be a String

attributes.background

string

required

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

Must be a String

attributes.border

string

required

Border line style

Must be one of: none, solid, dashed, dotted.

attributes.border_width

string

required

none, small (1px), medium (2px), large (4px), or a per-side array

Must be a String

attributes.border_color

string

required

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

Must be a String

attributes.border_radius

string

required

Corner rounding

Must be one of: rounded, full.

attributes.direction

string

required

Flex direction of children

Must be one of: horizontal, vertical.

attributes.align

string

required

Main-axis alignment (also centres the cross-axis)

Must be one of: start, center, space-between, end.

attributes.columns

array

required

Per-child sizing, one entry per child by index: auto, fill, none, 25%, 50%, 75%

Must be an array of any type

attributes.order

numeric

required

Flex order within the parent

Must be a Integer

attributes.vertical_align

string

required

Cross-axis self-alignment

Must be one of: start, center.

attributes.width

string

required

Width: auto, full, or a box-size token

Must be one of: auto, full, 2x-small, x-small, small, medium, large, x-large, 2x-large.

attributes.height

string

required

Height: auto, full, or a box-size token

Must be one of: auto, full, 2x-small, x-small, small, medium, large, x-large, 2x-large.

attributes.max_width

string

required

Maximum width

Must be one of: small, medium, large.

attributes.max_height

string

required

Maximum height

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

children

array

required

Child segments

Must be an array of any type

Supported Formats

application/json

Returns

Response - No Content

Code 204 - application/json

type

string

required

The type of the segment

Must be one of: block_layout.

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.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.

attributes.padding

array

required

A spacing token: x-tight, tight, normal, loose, x-loose, 2x-loose, 3x-loose, or an array [all] / [vertical, horizontal] / [top, right, bottom, left]; “none” for no padding

Must be an array of any type

attributes.margin_top

string

required

A spacing token: x-tight, tight, normal, loose, x-loose, 2x-loose, 3x-loose, optionally negated with a leading - (e.g. -tight)

Must be a String

attributes.margin_right

string

required

See margin_top

Must be a String

attributes.margin_bottom

string

required

See margin_top

Must be a String

attributes.margin_left

string

required

See margin_top

Must be a String

attributes.background

string

required

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

Must be a String

attributes.border

string

required

Border line style

Must be one of: none, solid, dashed, dotted.

attributes.border_width

string

required

none, small (1px), medium (2px), large (4px), or a per-side array

Must be a String

attributes.border_color

string

required

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

Must be a String

attributes.border_radius

string

required

Corner rounding

Must be one of: rounded, full.

attributes.order

numeric

required

Flex order within the parent

Must be a Integer

attributes.vertical_align

string

required

Cross-axis self-alignment

Must be one of: start, center.

attributes.width

string

required

Width: auto, full, or a box-size token

Must be one of: auto, full, 2x-small, x-small, small, medium, large, x-large, 2x-large.

attributes.height

string

required

Height: auto, full, or a box-size token

Must be one of: auto, full, 2x-small, x-small, small, medium, large, x-large, 2x-large.

attributes.max_width

string

required

Maximum width

Must be one of: small, medium, large.

attributes.max_height

string

required

Maximum height

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

children

array

required

Child segments

Must be an array of any type

Supported Formats

application/json

Returns

Response - No Content

Code 204 - application/json

type

string

required

The type of the segment

Must be one of: inline_layout.

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.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.

attributes.padding

array

required

A spacing token: x-tight, tight, normal, loose, x-loose, 2x-loose, 3x-loose, or an array [all] / [vertical, horizontal] / [top, right, bottom, left]; “none” for no padding

Must be an array of any type

attributes.margin_top

string

required

A spacing token: x-tight, tight, normal, loose, x-loose, 2x-loose, 3x-loose, optionally negated with a leading - (e.g. -tight)

Must be a String

attributes.margin_right

string

required

See margin_top

Must be a String

attributes.margin_bottom

string

required

See margin_top

Must be a String

attributes.margin_left

string

required

See margin_top

Must be a String

attributes.background

string

required

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

Must be a String

attributes.border

string

required

Border line style

Must be one of: none, solid, dashed, dotted.

attributes.border_width

string

required

none, small (1px), medium (2px), large (4px), or a per-side array

Must be a String

attributes.border_color

string

required

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

Must be a String

attributes.border_radius

string

required

Corner rounding

Must be one of: rounded, full.

attributes.direction

string

required

Flex direction of children

Must be one of: horizontal, vertical.

attributes.align

string

required

Main-axis alignment (also centres the cross-axis)

Must be one of: start, center, space-between, end.

attributes.columns

array

required

Per-child sizing, one entry per child by index: auto, fill, none, 25%, 50%, 75%

Must be an array of any type

attributes.order

numeric

required

Flex order within the parent

Must be a Integer

attributes.vertical_align

string

required

Cross-axis self-alignment

Must be one of: start, center.

attributes.width

string

required

Width: auto, full, or a box-size token

Must be one of: auto, full, 2x-small, x-small, small, medium, large, x-large, 2x-large.

attributes.height

string

required

Height: auto, full, or a box-size token

Must be one of: auto, full, 2x-small, x-small, small, medium, large, x-large, 2x-large.

attributes.max_width

string

required

Maximum width

Must be one of: small, medium, large.

attributes.max_height

string

required

Maximum height

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

children

array

required

Child segments

Must be an array of any type

Supported Formats

application/json

Returns

Response - No Content

Code 204 - application/json

type

string

required

The type of the segment

Must be one of: grid.

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.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.

attributes.padding

array

required

A spacing token: x-tight, tight, normal, loose, x-loose, 2x-loose, 3x-loose, or an array [all] / [vertical, horizontal] / [top, right, bottom, left]; “none” for no padding

Must be an array of any type

attributes.margin_top

string

required

A spacing token: x-tight, tight, normal, loose, x-loose, 2x-loose, 3x-loose, optionally negated with a leading - (e.g. -tight)

Must be a String

attributes.margin_right

string

required

See margin_top

Must be a String

attributes.margin_bottom

string

required

See margin_top

Must be a String

attributes.margin_left

string

required

See margin_top

Must be a String

attributes.background

string

required

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

Must be a String

attributes.border

string

required

Border line style

Must be one of: none, solid, dashed, dotted.

attributes.border_width

string

required

none, small (1px), medium (2px), large (4px), or a per-side array

Must be a String

attributes.border_color

string

required

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

Must be a String

attributes.border_radius

string

required

Corner rounding

Must be one of: rounded, full.

attributes.direction

string

required

Flex direction of children

Must be one of: horizontal, vertical.

attributes.align

string

required

Main-axis alignment (also centres the cross-axis)

Must be one of: start, center, space-between, end.

attributes.columns

array

required

Per-child sizing, one entry per child by index: auto, fill, none, 25%, 50%, 75%

Must be an array of any type

attributes.order

numeric

required

Flex order within the parent

Must be a Integer

attributes.vertical_align

string

required

Cross-axis self-alignment

Must be one of: start, center.

attributes.width

string

required

Width: auto, full, or a box-size token

Must be one of: auto, full, 2x-small, x-small, small, medium, large, x-large, 2x-large.

attributes.height

string

required

Height: auto, full, or a box-size token

Must be one of: auto, full, 2x-small, x-small, small, medium, large, x-large, 2x-large.

attributes.max_width

string

required

Maximum width

Must be one of: small, medium, large.

attributes.max_height

string

required

Maximum height

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

children

array

required

Child segments

Must be an array of any type

Supported Formats

application/json

Returns

Response - No Content

Code 204 - application/json

type

string

required

The type of the segment

Must be one of: newline.

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

children

array

required

Child segments rendered after the line break

Must be an array of any type

Supported Formats

application/json

Returns

Response - No Content

Code 204 - application/json

type

string

required

The type of the segment

Must be one of: text.

text

string

required

The text content to render

Must be a String

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.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.

attributes.emphasis

string

required

Inline emphasis (selects the wrapping element)

Must be one of: bold, italic, del.

attributes.white_space

string

required

Prevent the text from wrapping

Must be one of: nowrap.

children

array

required

Child segments (nested text runs)

Must be an array of any type

Supported Formats

application/json

Returns

Response - No Content

Code 204 - application/json

type

string

required

The type of the segment

Must be one of: image.

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.source

string

required

The image URL (rendered as the img src)

Must be a String

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.

attributes.padding

array

required

A spacing token: x-tight, tight, normal, loose, x-loose, 2x-loose, 3x-loose, or an array [all] / [vertical, horizontal] / [top, right, bottom, left]; “none” for no padding

Must be an array of any type

attributes.margin_top

string

required

A spacing token: x-tight, tight, normal, loose, x-loose, 2x-loose, 3x-loose, optionally negated with a leading - (e.g. -tight)

Must be a String

attributes.margin_right

string

required

See margin_top

Must be a String

attributes.margin_bottom

string

required

See margin_top

Must be a String

attributes.margin_left

string

required

See margin_top

Must be a String

attributes.background

string

required

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

Must be a String

attributes.border

string

required

Border line style

Must be one of: none, solid, dashed, dotted.

attributes.border_width

string

required

none, small (1px), medium (2px), large (4px), or a per-side array

Must be a String

attributes.border_color

string

required

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

Must be a String

attributes.border_radius

string

required

Corner rounding

Must be one of: rounded, full.

attributes.order

numeric

required

Flex order within the parent

Must be a Integer

attributes.vertical_align

string

required

Cross-axis self-alignment

Must be one of: start, center.

attributes.width

string

required

Width: auto, full, or a box-size token

Must be one of: auto, full, 2x-small, x-small, small, medium, large, x-large, 2x-large.

attributes.height

string

required

Height: auto, full, or a box-size token

Must be one of: auto, full, 2x-small, x-small, small, medium, large, x-large, 2x-large.

attributes.max_width

string

required

Maximum width

Must be one of: small, medium, large.

attributes.max_height

string

required

Maximum height

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

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

Supported Formats

application/json

Returns

Response - No Content

Code 204 - application/json

type

string

required

The type of the segment

Must be one of: link.

text

string

required

The link text; when omitted the children are rendered instead

Must be a String

url

string

required

Fallback link target used when attributes.to is absent

Must be a String

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.to

string

required

The link target (opens in a new tab)

Must be a String

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.

attributes.padding

array

required

A spacing token: x-tight, tight, normal, loose, x-loose, 2x-loose, 3x-loose, or an array [all] / [vertical, horizontal] / [top, right, bottom, left]; “none” for no padding

Must be an array of any type

attributes.margin_top

string

required

A spacing token: x-tight, tight, normal, loose, x-loose, 2x-loose, 3x-loose, optionally negated with a leading - (e.g. -tight)

Must be a String

attributes.margin_right

string

required

See margin_top

Must be a String

attributes.margin_bottom

string

required

See margin_top

Must be a String

attributes.margin_left

string

required

See margin_top

Must be a String

attributes.background

string

required

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

Must be a String

attributes.border

string

required

Border line style

Must be one of: none, solid, dashed, dotted.

attributes.border_width

string

required

none, small (1px), medium (2px), large (4px), or a per-side array

Must be a String

attributes.border_color

string

required

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

Must be a String

attributes.border_radius

string

required

Corner rounding

Must be one of: rounded, full.

attributes.order

numeric

required

Flex order within the parent

Must be a Integer

attributes.vertical_align

string

required

Cross-axis self-alignment

Must be one of: start, center.

attributes.width

string

required

Width: auto, full, or a box-size token

Must be one of: auto, full, 2x-small, x-small, small, medium, large, x-large, 2x-large.

attributes.height

string

required

Height: auto, full, or a box-size token

Must be one of: auto, full, 2x-small, x-small, small, medium, large, x-large, 2x-large.

attributes.max_width

string

required

Maximum width

Must be one of: small, medium, large.

attributes.max_height

string

required

Maximum height

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

children

array

required

Child segments rendered inside the link

Must be an array of any type

Supported Formats

application/json

Returns

Response - No Content

Code 204 - application/json

type

string

required

The type of the segment

Must be one of: button.

text

string

required

The button label; when omitted the children are rendered instead

Must be a String

url

string

required

Fallback link target used when attributes.to is absent

Must be a String

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.to

string

required

The link target (opens in a new tab)

Must be a String

attributes.kind

string

required

Semantic label for the button (e.g. primary/secondary), consumed by analytics

Must be a String

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.

attributes.padding

array

required

A spacing token: x-tight, tight, normal, loose, x-loose, 2x-loose, 3x-loose, or an array [all] / [vertical, horizontal] / [top, right, bottom, left]; “none” for no padding

Must be an array of any type

attributes.margin_top

string

required

A spacing token: x-tight, tight, normal, loose, x-loose, 2x-loose, 3x-loose, optionally negated with a leading - (e.g. -tight)

Must be a String

attributes.margin_right

string

required

See margin_top

Must be a String

attributes.margin_bottom

string

required

See margin_top

Must be a String

attributes.margin_left

string

required

See margin_top

Must be a String

attributes.background

string

required

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

Must be a String

attributes.border

string

required

Border line style

Must be one of: none, solid, dashed, dotted.

attributes.border_width

string

required

none, small (1px), medium (2px), large (4px), or a per-side array

Must be a String

attributes.border_color

string

required

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

Must be a String

attributes.border_radius

string

required

Corner rounding

Must be one of: rounded, full.

attributes.order

numeric

required

Flex order within the parent

Must be a Integer

attributes.vertical_align

string

required

Cross-axis self-alignment

Must be one of: start, center.

attributes.width

string

required

Width: auto, full, or a box-size token

Must be one of: auto, full, 2x-small, x-small, small, medium, large, x-large, 2x-large.

attributes.height

string

required

Height: auto, full, or a box-size token

Must be one of: auto, full, 2x-small, x-small, small, medium, large, x-large, 2x-large.

attributes.max_width

string

required

Maximum width

Must be one of: small, medium, large.

attributes.max_height

string

required

Maximum height

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

children

array

required

Child segments rendered inside the button

Must be an array of any type

Supported Formats

application/json

Returns

Response - No Content

Code 204 - application/json

type

string

required

The type of the segment

Must be one of: icon.

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

Attributes of the segment

Must be a Hash

Supported Formats

application/json

Returns

Response - No Content

Code 204 - application/json

type

string

required

The type of the segment

Must be one of: badge.

text

string

required

The badge text

Must be a String

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.tone

string

required

Structural tone label for the badge

Must be a String

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.

attributes.padding

array

required

A spacing token: x-tight, tight, normal, loose, x-loose, 2x-loose, 3x-loose, or an array [all] / [vertical, horizontal] / [top, right, bottom, left]; “none” for no padding

Must be an array of any type

attributes.margin_top

string

required

A spacing token: x-tight, tight, normal, loose, x-loose, 2x-loose, 3x-loose, optionally negated with a leading - (e.g. -tight)

Must be a String

attributes.margin_right

string

required

See margin_top

Must be a String

attributes.margin_bottom

string

required

See margin_top

Must be a String

attributes.margin_left

string

required

See margin_top

Must be a String

attributes.background

string

required

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

Must be a String

attributes.border

string

required

Border line style

Must be one of: none, solid, dashed, dotted.

attributes.border_width

string

required

none, small (1px), medium (2px), large (4px), or a per-side array

Must be a String

attributes.border_color

string

required

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

Must be a String

attributes.border_radius

string

required

Corner rounding

Must be one of: rounded, full.

Supported Formats

application/json

Returns

Response - No Content

Code 204 - application/json

type

string

required

The type of the segment

Must be one of: spacer.

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.display

string

required

Display mode (auto renders as flex)

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

attributes.padding

array

required

A spacing token: x-tight, tight, normal, loose, x-loose, 2x-loose, 3x-loose, or an array [all] / [vertical, horizontal] / [top, right, bottom, left]; “none” for no padding

Must be an array of any type

attributes.margin_top

string

required

A spacing token: x-tight, tight, normal, loose, x-loose, 2x-loose, 3x-loose, optionally negated with a leading - (e.g. -tight)

Must be a String

attributes.margin_right

string

required

See margin_top

Must be a String

attributes.margin_bottom

string

required

See margin_top

Must be a String

attributes.margin_left

string

required

See margin_top

Must be a String

attributes.background

string

required

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

Must be a String

attributes.border

string

required

Border line style

Must be one of: none, solid, dashed, dotted.

attributes.border_width

string

required

none, small (1px), medium (2px), large (4px), or a per-side array

Must be a String

attributes.border_color

string

required

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

Must be a String

attributes.border_radius

string

required

Corner rounding

Must be one of: rounded, full.

attributes.order

numeric

required

Flex order within the parent

Must be a Integer

attributes.vertical_align

string

required

Cross-axis self-alignment

Must be one of: start, center.

attributes.width

string

required

Width: auto, full, or a box-size token

Must be one of: auto, full, 2x-small, x-small, small, medium, large, x-large, 2x-large.

attributes.height

string

required

Height: auto, full, or a box-size token

Must be one of: auto, full, 2x-small, x-small, small, medium, large, x-large, 2x-large.

attributes.max_width

string

required

Maximum width

Must be one of: small, medium, large.

attributes.max_height

string

required

Maximum height

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

Supported Formats

application/json

Returns

Response - No Content

Code 204 - application/json

type

string

required

The type of the segment

Must be one of: pressable.

url

string

required

Fallback link target used when attributes.to is absent

Must be a String

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.to

string

required

The link target; when present the pressable renders as a link

Must be a String

attributes.action

string

required

A client-side action hook surfaced to the SDK via data-*

Must be a String

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.

attributes.padding

array

required

A spacing token: x-tight, tight, normal, loose, x-loose, 2x-loose, 3x-loose, or an array [all] / [vertical, horizontal] / [top, right, bottom, left]; “none” for no padding

Must be an array of any type

attributes.margin_top

string

required

A spacing token: x-tight, tight, normal, loose, x-loose, 2x-loose, 3x-loose, optionally negated with a leading - (e.g. -tight)

Must be a String

attributes.margin_right

string

required

See margin_top

Must be a String

attributes.margin_bottom

string

required

See margin_top

Must be a String

attributes.margin_left

string

required

See margin_top

Must be a String

attributes.background

string

required

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

Must be a String

attributes.border

string

required

Border line style

Must be one of: none, solid, dashed, dotted.

attributes.border_width

string

required

none, small (1px), medium (2px), large (4px), or a per-side array

Must be a String

attributes.border_color

string

required

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

Must be a String

attributes.border_radius

string

required

Corner rounding

Must be one of: rounded, full.

attributes.order

numeric

required

Flex order within the parent

Must be a Integer

attributes.vertical_align

string

required

Cross-axis self-alignment

Must be one of: start, center.

attributes.width

string

required

Width: auto, full, or a box-size token

Must be one of: auto, full, 2x-small, x-small, small, medium, large, x-large, 2x-large.

attributes.height

string

required

Height: auto, full, or a box-size token

Must be one of: auto, full, 2x-small, x-small, small, medium, large, x-large, 2x-large.

attributes.max_width

string

required

Maximum width

Must be one of: small, medium, large.

attributes.max_height

string

required

Maximum height

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

children

array

required

Child segments rendered inside the pressable

Must be an array of any type

Events

Feedbacks

Flows

Items

Offers

Segments

Segments

Supported Formats

HEAD /v1/segments/modal Modal

Supported Formats

Returns

Response - No Content

HEAD /v1/segments/view View

Supported Formats

Returns

Response - No Content

HEAD /v1/segments/block_layout Block Layout

Supported Formats

Returns

Response - No Content

HEAD /v1/segments/inline_layout Inline Layout

Supported Formats

Returns

Response - No Content

HEAD /v1/segments/grid Grid

Supported Formats

Returns

Response - No Content

HEAD /v1/segments/newline Newline

Supported Formats

Returns

Response - No Content

HEAD /v1/segments/text Text

Supported Formats

Returns

Response - No Content

HEAD /v1/segments/image Image

Supported Formats

Returns

Response - No Content

HEAD /v1/segments/heading Heading

Supported Formats

Returns

Response - No Content

HEAD /v1/segments/link Link

Supported Formats

Returns

Response - No Content

HEAD /v1/segments/button Button

Supported Formats

Returns

Response - No Content

HEAD /v1/segments/icon Icon

Supported Formats

Returns

Response - No Content

HEAD /v1/segments/badge Badge

Supported Formats

Returns

Response - No Content

HEAD /v1/segments/spacer Spacer

Supported Formats

Returns

Response - No Content

HEAD /v1/segments/pressable Pressable

Supported Formats

Returns

Response - No Content

HEAD /v1/segments/modal
Modal

HEAD /v1/segments/view
View

HEAD /v1/segments/block_layout
Block Layout

HEAD /v1/segments/inline_layout
Inline Layout

HEAD /v1/segments/grid
Grid

HEAD /v1/segments/newline
Newline

HEAD /v1/segments/text
Text

HEAD /v1/segments/image
Image

HEAD /v1/segments/heading
Heading

HEAD /v1/segments/link
Link

HEAD /v1/segments/button
Button

HEAD /v1/segments/icon
Icon

HEAD /v1/segments/badge
Badge

HEAD /v1/segments/spacer
Spacer

HEAD /v1/segments/pressable
Pressable