Skip to main content
POST
Reserve one optional tip display attempt for the authenticated account and canvas.

Authorizations

Authorization
string
header
required

A WorkOS-dashboard-issued internal API key on Authorization: Bearer.

Body

application/json
tip_key
string
required

Stable identity of this optional tip across every content version.

Pattern: ^[a-z][a-z0-9_.-]{0,99}$
version
integer
required

Content version, increased only for materially new guidance; never overrides dismissal.

Required range: x <= 2147483647
canvas_id
string
required

The originating canvas request id; at most one tip is offered on this canvas.

Required string length: 1 - 200

Response

Success. request_id is present on every response.

offered
boolean
required

Whether this request reserved one display attempt; false when already offered or dismissed. A lost response may skip the optional tip.

request_id
string
required

Server-minted id for this request. Present on every response, success and error — quote it when reporting a problem.

Minimum string length: 1