RIrightmessage
Widgets

Create a widget

Adds a widget to the project's draft. Publish the draft to make it live.

Requires an API token with the write ability. Tokens created without abilities have *, which grants every ability.

post/{teamPid}/widgets

Request

  • Base URL
    https://api.rightmessage.com/v1
  • Auth
    HTTP bearer

Path parameters

teamPidstring required

Project ID: the public pid that appears in dashboard URLs (app.rightmessage.com/{teamPid}/…).

Request body

namestring required
type'modal' | 'bar' | 'toaster' | 'inline' | 'takeover'
flow_idstring nullable
is_enabledboolean
frequency'startover' | 'immediately' | 'pageview' | 'session' | 'none'
optionsstring[]

Response

WidgetResource

Changes

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