Create a new widget studio

Create new widget studio with given parameters

POST /widget-studio

Create a new widget studio

cURL

curl --request POST \
  --url https://api.kameleoon.com/widget-studio \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "elements": [],
  "eventActions": [],
  "eventConditions": [],
  "fonts": [
    {
      "fontFamily": "<string>",
      "fontSrc": "<string>",
      "fontWeights": [
        "<string>"
      ],
      "id": "<string>",
      "importSrc": "<string>"
    }
  ],
  "isLegacy": true,
  "screens": [
    {
      "id": "<string>",
      "name": "<string>",
      "templateName": "<string>"
    }
  ],
  "translation": {
    "defaultLanguageId": "<string>",
    "enabled": true,
    "languages": [
      {
        "IID": "<string>",
        "code": "<string>",
        "name": "<string>"
      }
    ]
  },
  "version": 123,
  "widgetEditorTemplate": "<string>"
}
'

201

{
  "dateCreated": "2023-11-07T05:31:56Z",
  "dateModified": "2023-11-07T05:31:56Z",
  "elements": [],
  "eventActions": [],
  "eventConditions": [],
  "fonts": [
    {
      "fontFamily": "<string>",
      "fontSrc": "<string>",
      "fontWeights": [
        "<string>"
      ],
      "id": "<string>",
      "importSrc": "<string>"
    }
  ],
  "isLegacy": true,
  "screens": [
    {
      "id": "<string>",
      "name": "<string>",
      "templateName": "<string>"
    }
  ],
  "translation": {
    "defaultLanguageId": "<string>",
    "enabled": true,
    "languages": [
      {
        "IID": "<string>",
        "code": "<string>",
        "name": "<string>"
      }
    ]
  },
  "version": 123,
  "widgetEditorTemplate": "<string>",
  "widgetId": 123
}

Authorizations

Authorization · string · header · required

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

Body

application/json

Represents the Widget Studio entity containing metadata and configurations.

elements · enum<string>[]

List of element types used in the widget studio.

List of element types used in the widget studio.

Available options: BOX, BUTTON, BUTTON_V2, CHECKBOX, CLOSE, COPY, COUNTDOWN, COUNTDOWN_V2, COUNTDOWN_PROGRESS_BAR, COUNTDOWN_V2_PROGRESS_BAR, DATE, FORM_ERROR_MESSAGE, GROUP, HEADING, HIDDEN_INPUT, HTML, IFRAME, IMAGE, INPUT, LINK, SCROLLING_TEXT, MULTI_STEP_FORM, PRODUCT_RECO, PROGRESS_BAR, RADIO_BUTTON, SELECT, SHAPE, SLIDER, STEP_PROGRESS_BAR, TEXT, TEXTAREA, TIME, TOOLTIP, TOGGLE, VIDEO, QR_CODE, RANGE_INPUT, SPIN_WHEEL, SCALE, SCRATCH_CARD, NPS, MULTI_CHOICE, SHORT_TEXT, LONG_TEXT

eventActions · enum<string>[]

List of event actions that can be triggered within the widget studio.

List of event actions that can be triggered within the widget studio.

Available options: SET_LOCAL_STORAGE, SET_SESSION_STORAGE, SET_COOKIES, SHOW_ELEMENT, HIDE_ELEMENT, SET_STEP, CLICK_ON_ELEMENT, FORM_DISABLE, FORM_ENABLE, JAVASCRIPT, PROCESS_CONVERSION, CANCEL_CONVERSION, SET_CUSTOM_DATA, TRIGGER_EVENT, SET_PROGRESS, SEND_DATA, RUN_ROTATION_SPIN_WHEEL, SET_LOCALE, URL_REDIRECT

eventConditions · enum<string>[]

List of event conditions that determine widget studio behavior.

List of event conditions that determine widget studio behavior.

Available options: BEFORE_DISPLAY, AFTER_DISPLAY, ON_COUNTDOWN_END, IS_MOBILE, IS_NOT_MOBILE, IS_TABLET, IS_NOT_TABLET, IS_DESKTOP, IS_NOT_DESKTOP, FORM_ITEM_VALUE, BY_CUSTOM_DATA, ON_CLICK, ON_SUCCESS, ON_ERROR, REVEALED_SCRATCH_CARD, ON_SPIN_WHEEL_TURNED, WIN_SLICE_VALUE, ON_TIMER_END, VISITOR_BROWSER_LANGUAGE, URL_CONTAINS, URL_REGEX, ON_VIDEO_END

fonts · object[]

List of custom fonts used within the widget studio.

Show child attributes

isLegacy · boolean

Indicate if the widget is part of a legacy system

screens · object[]

List of screens that are part of this widget studio configuration.

Show child attributes

translation · object

Translation settings for the widget studio.

Show child attributes

version · number<double>

Version of the widget, precision = 5, scale = 2.

widgetEditorTemplate · string

Serialized JSON representation of the widget configuration used in the editor.

Response

201

*/*

Created

Represents the Widget Studio entity containing metadata and configurations.

dateCreated · string<date-time> · read-only

Date the widget studio object was created.

dateModified · string<date-time> · read-only

Date the widget studio object was last modified.

elements · enum<string>[]

List of element types used in the widget studio.

List of element types used in the widget studio.

Available options: BOX, BUTTON, BUTTON_V2, CHECKBOX, CLOSE, COPY, COUNTDOWN, COUNTDOWN_V2, COUNTDOWN_PROGRESS_BAR, COUNTDOWN_V2_PROGRESS_BAR, DATE, FORM_ERROR_MESSAGE, GROUP, HEADING, HIDDEN_INPUT, HTML, IFRAME, IMAGE, INPUT, LINK, SCROLLING_TEXT, MULTI_STEP_FORM, PRODUCT_RECO, PROGRESS_BAR, RADIO_BUTTON, SELECT, SHAPE, SLIDER, STEP_PROGRESS_BAR, TEXT, TEXTAREA, TIME, TOOLTIP, TOGGLE, VIDEO, QR_CODE, RANGE_INPUT, SPIN_WHEEL, SCALE, SCRATCH_CARD, NPS, MULTI_CHOICE, SHORT_TEXT, LONG_TEXT

eventActions · enum<string>[]

List of event actions that can be triggered within the widget studio.

List of event actions that can be triggered within the widget studio.

Available options: SET_LOCAL_STORAGE, SET_SESSION_STORAGE, SET_COOKIES, SHOW_ELEMENT, HIDE_ELEMENT, SET_STEP, CLICK_ON_ELEMENT, FORM_DISABLE, FORM_ENABLE, JAVASCRIPT, PROCESS_CONVERSION, CANCEL_CONVERSION, SET_CUSTOM_DATA, TRIGGER_EVENT, SET_PROGRESS, SEND_DATA, RUN_ROTATION_SPIN_WHEEL, SET_LOCALE, URL_REDIRECT

eventConditions · enum<string>[]

List of event conditions that determine widget studio behavior.

List of event conditions that determine widget studio behavior.

Available options: BEFORE_DISPLAY, AFTER_DISPLAY, ON_COUNTDOWN_END, IS_MOBILE, IS_NOT_MOBILE, IS_TABLET, IS_NOT_TABLET, IS_DESKTOP, IS_NOT_DESKTOP, FORM_ITEM_VALUE, BY_CUSTOM_DATA, ON_CLICK, ON_SUCCESS, ON_ERROR, REVEALED_SCRATCH_CARD, ON_SPIN_WHEEL_TURNED, WIN_SLICE_VALUE, ON_TIMER_END, VISITOR_BROWSER_LANGUAGE, URL_CONTAINS, URL_REGEX, ON_VIDEO_END

fonts · object[]

List of custom fonts used within the widget studio.

Show child attributes

isLegacy · boolean

Indicate if the widget is part of a legacy system

screens · object[]

List of screens that are part of this widget studio configuration.

Show child attributes

translation · object

Translation settings for the widget studio.

Show child attributes

version · number<double>

Version of the widget, precision = 5, scale = 2.

widgetEditorTemplate · string

Serialized JSON representation of the widget configuration used in the editor.

widgetId · integer<int64> · read-only

Id of the widget.