Create a new template

POST 
/templates

Create a new template with given parameters

Request

application/json

Body

required

config string

Widget editor configuration field linked to the translation locales field in JSON format.

cssCode string

CSS that belongs to this template.

description string

Description of the template.

htmlCode string

UI text that belongs to this template.

isCustomTemplate boolean

Indicates if this is a custom template.

name string

Name of the template.

siteId int64required

Web Id of the studio template.

status string

Template status.

Possible values: [DRAFT, ACTIVE, PAUSED]

tags string[]

Tags that belong to this template.

templateCssCode string

CSS code that belongs to this template.

templateHtmlCode string

HTML code that belongs to this template.

templateJavaScriptCode string

JavaScript code that belongs to this template.

type string

Type of template.

Possible values: [TEMPLATE, EDITOR]

url string

Url associated with this template.

useCustomData boolean

Indicates if custom data is being used.

widgetEditorTemplate string

Widget editor code that belongs to this template.

Responses

201

Created

*/*

Schema

Schema

config string

Widget editor configuration field linked to the translation locales field in JSON format.

cssCode string

CSS that belongs to this template.

dateActivated date-time

Date when the widget was activated.

dateCreated date-time

Date when this widget was created

dateModified date-time

Date when this widget was modified

description string

Description of the template.

htmlCode string

UI text that belongs to this template.

id int64

Unique Id of the template

isCustomTemplate boolean

Indicates if this is a custom template.

name string

Name of the template.

siteId int64required

Web Id of the studio template.

status string

Template status.

Possible values: [DRAFT, ACTIVE, PAUSED]

tags string[]

Tags that belong to this template.

templateCssCode string

CSS code that belongs to this template.

templateHtmlCode string

HTML code that belongs to this template.

templateJavaScriptCode string

JavaScript code that belongs to this template.

type string

Type of template.

Possible values: [TEMPLATE, EDITOR]

url string

Url associated with this template.

useCustomData boolean

Indicates if custom data is being used.

widgetEditorTemplate string

Widget editor code that belongs to this template.

Example (from schema)

{
  "config": "string",
  "cssCode": "string",
  "dateActivated": "2024-07-29T15:51:28.071Z",
  "dateCreated": "2024-07-29T15:51:28.071Z",
  "dateModified": "2024-07-29T15:51:28.071Z",
  "description": "string",
  "htmlCode": "string",
  "id": 0,
  "isCustomTemplate": true,
  "name": "string",
  "siteId": 0,
  "status": "DRAFT",
  "tags": [
    "string"
  ],
  "templateCssCode": "string",
  "templateHtmlCode": "string",
  "templateJavaScriptCode": "string",
  "type": "TEMPLATE",
  "url": "string",
  "useCustomData": true,
  "widgetEditorTemplate": "string"
}

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"
}

401

Unauthorized

*/*

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"
}

404

Not Found

*/*

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...