Skip to main content
PUT
Set Signal Reaction

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

brand_id
integer
required
signal_id
integer
required

Body

application/json

Request body for setSignalReaction.

reaction
enum<string>
required

Reaction to set: useful, not_useful, dismissed, or actioned.

Available options:
useful,
not_useful,
dismissed,
actioned
reason
string | null

Optional free-text reason accompanying the reaction.

Maximum string length: 2000

Response

Successful Response

A user's reaction to a signal's stable identity.

user_id
integer
required

ID of the user the reaction belongs to.

insight_id
integer
required

Signal ID the reaction was last set on.

fingerprint
string
required

Stable signal identity the reaction follows across re-detections.

reaction
enum<string>
required

The reaction value.

Available options:
useful,
not_useful,
dismissed,
actioned
surface
enum<string>
required

Where the reaction was set: in_app, email, slack, or api.

Available options:
in_app,
email,
slack,
api
created_at
string<date-time>
required

When the reaction was first set (UTC).

updated_at
string<date-time>
required

When the reaction was last changed (UTC).

reason
string | null

Free-text reason, when provided.