Skip to main content
PATCH
Update a favorite

Authorizations

Authorization
string
header
required

Dashboard JWT token from Clerk

Headers

X-Test-Mode
enum<string>

Sandbox opt-in for Clerk-session-authenticated requests. Set to true to route the call through the test-mode pipeline: no real provider delivery, no credits deducted, response meta.test_mode: true. Ignored for live API keys (dv_live_sk_*) — server-to-server clients must use a test-prefixed key (dv_test_sk_*) to exercise sandbox. Test-prefixed keys unconditionally enable sandbox regardless of this header.

Available options:
true,
false

Path Parameters

id
string
required

Favorite id (favorite_ + suffix), as returned by create or list.

Required string length: 1 - 64

Body

application/json
label
string | null

Replacement display label (≤ 64 chars), or null to clear the label.

Maximum string length: 64
sort_order
integer

New position in the favorites list — lower sorts first.

Required range: 0 <= x <= 100000

Response

data.updated plus the updated favorite when a recognised field was supplied (data.favorite), or data.updated: false for a no-op body.

data.updated plus the updated favorite when a recognised field was supplied (data.favorite), or data.updated: false for a no-op body.

data
object
meta
object