Create a new widget studio

POST 
/widget-studio

Create new widget studio with given parameters

Request

application/json

Body

required

elements string[]

List of element types used in the widget studio.

Possible values: [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 string[]

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

Possible values: [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 string[]

List of event conditions that determine widget studio behavior.

Possible values: [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.

Array [

fontFamily string

fontSrc string

fontWeights string[]

id string

importSrc string

]

isLegacy boolean

Boolean field is used to indicate whether a widget is part of the legacy system

screens

object[]

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

Array [

id string

name string

templateName string

]

translation

object

Translation configuration settings for the widget studio.

defaultLanguageId string

enabled boolean

languages

object[]

Array [

IID string

code string

name string

]

version double

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

widgetEditorTemplate string

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

Responses

201

Created

*/*

Schema

Schema

dateCreated date-time

Timestamp indicating when the widget studio object was created.

dateModified date-time

Timestamp indicating when the widget studio object was last modified.

elements string[]

List of element types used in the widget studio.

Possible values: [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 string[]

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

Possible values: [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 string[]

List of event conditions that determine widget studio behavior.

Possible values: [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.

Array [

fontFamily string

fontSrc string

fontWeights string[]

id string

importSrc string

]

isLegacy boolean

Boolean field is used to indicate whether a widget is part of the legacy system

screens

object[]

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

Array [

id string

name string

templateName string

]

translation

object

Translation configuration settings for the widget studio.

defaultLanguageId string

enabled boolean

languages

object[]

Array [

IID string

code string

name string

]

version double

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

widgetEditorTemplate string

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

widgetId int64

Unique identifier of the associated widget.

Example (from schema)

{
  "dateCreated": "2024-07-29T15:51:28.071Z",
  "dateModified": "2024-07-29T15:51:28.071Z",
  "elements": [
    "BOX"
  ],
  "eventActions": [
    "SET_LOCAL_STORAGE"
  ],
  "eventConditions": [
    "BEFORE_DISPLAY"
  ],
  "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": 0,
  "widgetEditorTemplate": "string",
  "widgetId": 0
}

400

Bad Request

*/*

Schema

Schema

code string
impersonator string
message string
name string
status string

Possible values: [SUCCESS, ERROR]

sub string
time int64
timestamp date-time

Example (from schema)

{
  "code": "string",
  "impersonator": "string",
  "message": "string",
  "name": "string",
  "status": "SUCCESS",
  "sub": "string",
  "time": 0,
  "timestamp": "2024-07-29T15:51:28.071Z"
}

403

Forbidden

*/*

Schema

Schema

code string
impersonator string
message string
name string
status string

Possible values: [SUCCESS, ERROR]

sub string
time int64
timestamp date-time

Example (from schema)

{
  "code": "string",
  "impersonator": "string",
  "message": "string",
  "name": "string",
  "status": "SUCCESS",
  "sub": "string",
  "time": 0,
  "timestamp": "2024-07-29T15:51:28.071Z"
}

423

Locked

*/*

Schema

Schema

code string
impersonator string
message string
name string
status string

Possible values: [SUCCESS, ERROR]

sub string
time int64
timestamp date-time

Example (from schema)

{
  "code": "string",
  "impersonator": "string",
  "message": "string",
  "name": "string",
  "status": "SUCCESS",
  "sub": "string",
  "time": 0,
  "timestamp": "2024-07-29T15:51:28.071Z"
}

500

Internal Server Error

*/*

Schema

Schema

code string
impersonator string
message string
name string
status string

Possible values: [SUCCESS, ERROR]

sub string
time int64
timestamp date-time

Example (from schema)

{
  "code": "string",
  "impersonator": "string",
  "message": "string",
  "name": "string",
  "status": "SUCCESS",
  "sub": "string",
  "time": 0,
  "timestamp": "2024-07-29T15:51:28.071Z"
}

Loading...