Skip to content

Permanently dismiss a nudge

POST
/api/context/nudges/{nudge_id}/dismiss

Persist nudge_id into the dismissed-forever registry.

Idempotent: re-dismissing an already-dismissed nudge updates the timestamp but doesn’t error.

nudge_id
required
Nudge Id

Nudge identifier

string
>= 1 characters <= 128 characters

Nudge identifier

Successful Response

DismissNudgeResponse

POST /api/context/nudges/{id}/dismiss response.

object
nudgeId
required
Nudgeid
string
dismissedAt
required
Dismissedat
integer

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object