guide

Guide Nudge Endpoint

Send the first-run message due for the place the user is in and return it; null when nothing is due. The app calls this on every page a new user opens in a channel or a project. Ownership of either is checked; outside both there are no first-run messages.

post/guide/nudge

Request

  • Base URL: https://api.framesail.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.framesail.com/guide/nudge
  • Auth: HTTP bearer

Request body

project_idstring nullable
channel_idstring nullable
routestring required

Response

Successful Response

idstring required
scope'global' | 'channel' | 'project' required
scope_idstring nullable required
role'user' | 'assistant' | 'nudge' required
contentstring required
nudge_idstring nullable required
categorystring nullable required
rating'up' | 'down' nullable
created_atstring required

Changes

No recorded changes to this operation across all 1 revision of this API.