Skip to main content
PUT

Page Theme

Retrieve (GET) or set (PUT) the complete styling and layout token configuration for an okl.ink page.

1. Get Theme (GET /api/v1/pages/{id}/theme)

Requires pages:read scope.

Response

Returns the stored ThemeConfig JSON object or null.

2. Set Theme (PUT /api/v1/pages/{id}/theme)

Requires pages:write scope.

Request Body

string
required
One of: oklink, midnight, paper, vivid, lofi.
string | null
Optional custom hex background (e.g. #111827).
string | null
Optional custom hex accent color (e.g. #10b981).
One of: rounded, pill, outline, filled, minimal.
string
default:"modern"
One of: modern, editorial, mono, geist.
string
default:"rounded"
One of: sharp, rounded, soft, pill.
string
default:"comfortable"
One of: compact, comfortable, airy.
string
default:"duotone"
One of: duotone, filled, colored.
string
default:"grid"
grid or list.
boolean
default:"true"
Whether to render the creator avatar and byline in header.

Response

boolean
Returns true when the theme update succeeds.