LYlytics
Widgets

Create widget

Changed on

Create a widget. The server assigns its id and it starts as version 1 in draft; the request must not name an id or version, or a state other than draft.

post/widget

Request

  • Base URL
    https://api.lytics.io/v2
  • URL
    https://api.lytics.io/v2/widget
  • Auth
    API key in header Authorization

Query parameters

account_idstring

The account ID. Defaults to the user's default account.

Request body

aidinteger
configobject

Raw Pathfora SDK config

createdstring date-time
custom_rule_functionstring
descriptionstring
excluded_segment_idsstring[]
idstring
labelstring
modifiedstring date-time
personalization_keystring
published_atstring date-time
slugstring
state'draft' | 'published' | 'paused' | 'deleted'
state_modified_atstring date-time
target_segment_idsstring[]
versioninteger
widget_type'message' | 'form' | 'sitegate'

Response

Created Widget

_metaobject

Response Metadata

request_idstring
statusinteger

HTTP Status Code

Changes