Skip to main content
POST
Create a dashboard draft

Authorizations

Authorization
string
header
required

An API key (utk_live_...) or an app's OAuth access token (uto_...).

Headers

Idempotency-Key
string

Any 1 to 255 printable ASCII characters, without a space at either end. The answer to the first request with a key is kept for 24 hours per credential: the same request again gets it back (Idempotent-Replayed: true), another request with the key is 409 PUB-002-002, and while the first still runs 409 PUB-002-003. A server error is not kept, and a request that never answered frees its key after 2 minutes: a retry with the key then runs again.

Maximum string length: 255

Body

application/json
name
string
required
Required string length: 1 - 255
description
string | null

null clears it.

Maximum string length: 1000
icon
string | null

A tile icon key of the dashboard's icon set.

Maximum string length: 40
color
string | null

A tile color key of the dashboard's palette.

Maximum string length: 40
cards
object[] | null

0 to 500 cards, in the board's order. The plan's cards per dashboard and the 128 KB layout bound it first.

Maximum array length: 500

Response

Created.

id
string<uuid>
required
name
string
required
description
string | null
required
icon
string | null
required
color
string | null
required
visibility
enum<string>
required
Available options:
organization,
private
isDefault
boolean
required
readOnlyByPlan
boolean
required
hasUnpublishedChanges
boolean
required

True while the draft holds changes viewers don't see yet.

draftVersion
integer
required

Send it back as expectedDraftVersion on the next edit.

editable
boolean
required
cards
object[]
required

The draft's cards (the published ones while nothing waits).

url
string<uri>
required
editorUrl
string<uri>
required

Opens the board in edit mode in Usertick, where a person reviews the draft and selects Publish.

draftUpdatedAt
string<date-time> | null
required
Example:

"2026-09-30T10:00:00.000Z"

createdAt
string<date-time>
required
Example:

"2026-09-30T10:00:00.000Z"

updatedAt
string<date-time> | null
required
Example:

"2026-09-30T10:00:00.000Z"

aiGenerated
boolean
required
aiGeneratedAt
string<date-time> | null
required

When text Usertick AI wrote was first stored here; null when people wrote all of it.

Example:

"2026-09-30T10:00:00.000Z"

Last modified on November 9, 2026