Partially update template

PATCH 
/templates/:templateId

Update several fields of template

Request

Path Parameters

templateId int64required
The ID of the template object
Example: 100000

application/json

Body

required

config string

The widget editor configuration field is connected to the translation locales field in JSON format

description string

Description of template

isCustomTemplate boolean

Boolean value to indicate if a custom template is being used

name string

Name for the given template

siteId int64

Website id that a template belongs to

status string

Template status

Possible values: [DRAFT, ACTIVE, PAUSED]

tags string[]

Field to store tags that are associated with this template

templateCssCode string

Template CSS script that is associated with this template

templateHtmlCode string

Template html markup text that is associated with this template

templateJavaScriptCode string

Template JavaScript code that is associated with this template

type string

Type of template

Possible values: [TEMPLATE, EDITOR]

uiCssCode string

UI CSS script that is associated with this template

uiHtmlCode string

UI HTML markup text that is associated with this template

url string

Url associated with this template

useCustomData boolean

Boolean value to indicate if custom data is being used

widgetEditorTemplate string

Widget editor code that is associated with this template

Responses

200

OK

*/*

Schema

Schema

config string

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

cssCode string

UI CSS script that is associated with this template.

dateActivated date-time

Timestamp of when a record is activated.

dateCreated date-time

Timestamp of when a record is created.

dateModified date-time

Timestamp of when a record is modified.

description string

Description of template.

htmlCode string

UI Html markup text that is associated with this template.

id int64

Unique identifier of the given template.

isCustomTemplate boolean

Boolean value of is custom template.

name string

Name for the given template.

siteId int64required

Website id of the studio template.

status string

Template status.

Possible values: [DRAFT, ACTIVE, PAUSED]

tags string[]

Field to store tags that are associated with this template.

templateCssCode string

Template CSS script that is associated with this template.

templateHtmlCode string

Template HTML markup that is associated with this template.

templateJavaScriptCode string

Template JavaScript code that is associated with this template.

type string

Type of template.

Possible values: [TEMPLATE, EDITOR]

url string

Url associated with this template.

useCustomData boolean

Boolean value to indicate if custom data is being used.

widgetEditorTemplate string

Widget editor code that is associated with 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"
}

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