Skip to main content

Theme

The Theme module makes theme management more efficient and effective. It allows you to view all theme pages, obtain details about specific theme pages, check the current app theme, and preview and test themes before applying them live.

Sales Channel Theme

Theme API provides a comprehensive set of tools to efficiently manage assets and global configurations for web themes. With these APIs, developers can seamlessly handle essential asset details such as JavaScript (JS) and CSS bundle URLs, along with image URLs, crucial for creating visually appealing themes. Moreover, the APIs empower sales channel users to contribute by adding data for global configurations, including color palettes and other theme global settings.

Operations
GET
/service/platform/theme/v1.0/company/{company_id}/application/{application_id}/fonts
# List theme fonts
GET
/service/platform/theme/v2.0/company/{company_id}/application/{application_id}/themes
# List sales channel themes
GET
/service/platform/theme/v2.0/company/{company_id}/application/{application_id}/application_themes_count
# Get sales channel themes count
GET
/service/platform/theme/v2.0/company/{company_id}/application/{application_id}/{theme_id}
# Get theme
PUT
/service/platform/theme/v2.0/company/{company_id}/application/{application_id}/{theme_id}
# Update theme
DEL
/service/platform/theme/v2.0/company/{company_id}/application/{application_id}/{theme_id}
# Delete theme
POST
/service/platform/theme/v2.0/company/{company_id}/application/{application_id}/
# Create theme in sales channel
PATCH
/service/platform/theme/v2.0/company/{company_id}/application/{application_id}/{theme_id}/name
# Update theme name
PATCH
/service/platform/theme/v2.0/company/{company_id}/application/{application_id}/{theme_id}/apply
# Apply a theme
POST
/service/platform/theme/v2.0/company/{company_id}/application/{application_id}/{theme_id}/duplicate
# Duplicate a theme
GET
/service/platform/theme/v2.0/company/{company_id}/application/{application_id}
# Get applied theme
GET
/service/platform/theme/v2.0/company/{company_id}/application/{application_id}/{theme_id}/preview
# Get theme for preview
HEAD
/service/platform/theme/v2.0/company/{company_id}/application/{application_id}/{theme_id}/polling
# Get theme last modified date
GET
/service/platform/theme/v2.0/company/{company_id}/application/{application_id}/{theme_id}/upgradable
# Check theme is upgradable
PUT
/service/platform/theme/v2.0/company/{company_id}/application/{application_id}/{theme_id}/upgrade
# Upgrade theme
GET

List theme fonts

Retrieve a list of available fonts that can be used by themes in the platform.
Parameters
No Parameters
Response
200
4XX
5XX
Success. Refer `FontsSchema` for more details.
FontsSchema
items
object (FontsSchemaItems)
Optional
FontsSchemaItems
kind
string
Optional
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/platform/theme/v1.0/company/{company_id}/application/{application_id}/fonts
Loading...
Response
Example response not available.
GET

List sales channel themes

Retrieve all draft themes added to sales channel from theme collection.
Parameters
No Parameters
Response
200
The list of themes for the application was fetched successfully.
Array of ThemesSchema
font
object (Font)
Optional
Font
config
object (Config)
Optional
Config
applied
boolean
Optional
Whether the theme has been applied or not
is_private
boolean
Optional
Whether the theme is private or not
tags
array of string
Optional
An array of tags associated with the theme
_id
string
Optional
The unique identifier of the theme
application_id
string
Optional
The ID of the application
marketplace_theme_id
string
Optional
The ID of the theme in the marketplace
meta
object (ThemeMeta)
Optional
ThemeMeta
name
string
Optional
The name of the theme
template_theme_id
string
Optional
The ID of the template theme
version
string
Optional
The version of the theme
styles
object
Optional
The styles associated with the theme
created_at
string
Optional
The creation timestamp of the theme
updated_at
string
Optional
The last update timestamp of the theme
assets
object (Assets)
Optional
Assets
available_sections
array of object (SectionItem)
Optional
Available sections information
Array of SectionItem
theme_type
string
Optional
Enum
company_id
number
Optional
The company id in which sales channel exists
src
string
Optional
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/platform/theme/v2.0/company/{company_id}/application/{application_id}/themes
Loading...
Response
Example response not available.
GET

Get sales channel themes count

Retrieve count of all draft themes added to sales channel from theme collection.
Parameters
No Parameters
Response
200
The count of themes for the application was fetched successfully.
Properties
message
string
Optional
A message indicating the success of fetching the themes count.
count
integer
Optional
The count of themes for the application.
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/platform/theme/v2.0/company/{company_id}/application/{application_id}/application_themes_count
Loading...
Response
Loading...
GET

Get theme

Retrieve a theme by its unique identifier. Response contains theme template data and data stored in theme editor.
Parameters
themeId
string
The ID of the theme
Response
200
The Details of themes for the application was fetched successfully.
ThemesSchema
font
object (Font)
Optional
Font
config
object (Config)
Optional
Config
applied
boolean
Optional
Whether the theme has been applied or not
is_private
boolean
Optional
Whether the theme is private or not
tags
array of string
Optional
An array of tags associated with the theme
_id
string
Optional
The unique identifier of the theme
application_id
string
Optional
The ID of the application
marketplace_theme_id
string
Optional
The ID of the theme in the marketplace
meta
object (ThemeMeta)
Optional
ThemeMeta
name
string
Optional
The name of the theme
template_theme_id
string
Optional
The ID of the template theme
version
string
Optional
The version of the theme
styles
object
Optional
The styles associated with the theme
created_at
string
Optional
The creation timestamp of the theme
updated_at
string
Optional
The last update timestamp of the theme
assets
object (Assets)
Optional
Assets
available_sections
array of object (SectionItem)
Optional
Available sections information
Array of SectionItem
theme_type
string
Optional
Enum
company_id
number
Optional
The company id in which sales channel exists
src
string
Optional
Examples
Parameters
themeId:
"value"
Was this section helpful?
GET
/service/platform/theme/v2.0/company/{company_id}/application/{application_id}/{theme_id}
Loading...
Response
Loading...
PUT

Update theme

Modify and update the content and settings of a theme.
Parameters
themeId
string
The ID of the theme.
body
object (UpdateThemeRequestBody)
UpdateThemeRequestBody
config
object (Config)
Optional
Config
font
object (Font)
Optional
Font
Response
200
Theme updated successfully
ThemesSchema
font
object (Font)
Optional
Font
config
object (Config)
Optional
Config
applied
boolean
Optional
Whether the theme has been applied or not
is_private
boolean
Optional
Whether the theme is private or not
tags
array of string
Optional
An array of tags associated with the theme
_id
string
Optional
The unique identifier of the theme
application_id
string
Optional
The ID of the application
marketplace_theme_id
string
Optional
The ID of the theme in the marketplace
meta
object (ThemeMeta)
Optional
ThemeMeta
name
string
Optional
The name of the theme
template_theme_id
string
Optional
The ID of the template theme
version
string
Optional
The version of the theme
styles
object
Optional
The styles associated with the theme
created_at
string
Optional
The creation timestamp of the theme
updated_at
string
Optional
The last update timestamp of the theme
assets
object (Assets)
Optional
Assets
available_sections
array of object (SectionItem)
Optional
Available sections information
Array of SectionItem
theme_type
string
Optional
Enum
company_id
number
Optional
The company id in which sales channel exists
src
string
Optional
Examples
Parameters
Parameters are not required.
Was this section helpful?
PUT
/service/platform/theme/v2.0/company/{company_id}/application/{application_id}/{theme_id}
Loading...
Response
Example response not available.
DEL

Delete theme

Remove a theme from theme drafts of a sales channel.
Parameters
themeId
string
The ID of the theme to be deleted.
Response
200
Theme successfully deleted.
ThemesSchema
font
object (Font)
Optional
Font
config
object (Config)
Optional
Config
applied
boolean
Optional
Whether the theme has been applied or not
is_private
boolean
Optional
Whether the theme is private or not
tags
array of string
Optional
An array of tags associated with the theme
_id
string
Optional
The unique identifier of the theme
application_id
string
Optional
The ID of the application
marketplace_theme_id
string
Optional
The ID of the theme in the marketplace
meta
object (ThemeMeta)
Optional
ThemeMeta
name
string
Optional
The name of the theme
template_theme_id
string
Optional
The ID of the template theme
version
string
Optional
The version of the theme
styles
object
Optional
The styles associated with the theme
created_at
string
Optional
The creation timestamp of the theme
updated_at
string
Optional
The last update timestamp of the theme
assets
object (Assets)
Optional
Assets
available_sections
array of object (SectionItem)
Optional
Available sections information
Array of SectionItem
theme_type
string
Optional
Enum
company_id
number
Optional
The company id in which sales channel exists
src
string
Optional
Examples
Parameters
Parameters are not required.
Was this section helpful?
DEL
/service/platform/theme/v2.0/company/{company_id}/application/{application_id}/{theme_id}
Loading...
Response
Example response not available.
POST

Create theme in sales channel

Include a theme in an application drafts from theme collection.
Parameters
body
object (ThemeReq)
ThemeReq
marketplace_theme_id
string
Optional
The ID of the marketplace theme to apply to the company.
Response
200
4XX
5XX
Theme
ThemesSchema
font
object (Font)
Optional
Font
config
object (Config)
Optional
Config
applied
boolean
Optional
Whether the theme has been applied or not
is_private
boolean
Optional
Whether the theme is private or not
tags
array of string
Optional
An array of tags associated with the theme
_id
string
Optional
The unique identifier of the theme
application_id
string
Optional
The ID of the application
marketplace_theme_id
string
Optional
The ID of the theme in the marketplace
meta
object (ThemeMeta)
Optional
ThemeMeta
name
string
Optional
The name of the theme
template_theme_id
string
Optional
The ID of the template theme
version
string
Optional
The version of the theme
styles
object
Optional
The styles associated with the theme
created_at
string
Optional
The creation timestamp of the theme
updated_at
string
Optional
The last update timestamp of the theme
assets
object (Assets)
Optional
Assets
available_sections
array of object (SectionItem)
Optional
Available sections information
Array of SectionItem
theme_type
string
Optional
Enum
company_id
number
Optional
The company id in which sales channel exists
src
string
Optional
Examples
Parameters
body:
body
Was this section helpful?
POST
/service/platform/theme/v2.0/company/{company_id}/application/{application_id}/
Loading...
Response
Example response not available.
PATCH

Update theme name

Modify the name of the draft theme by theme Id.
Parameters
themeId
string
The ID of the theme to be updated.
body
object (UpdateThemeNameRequestBody)
UpdateThemeNameRequestBody
name
string
Optional
The new name of the theme.
Response
200
Theme name updated successfully.
ThemesSchema
font
object (Font)
Optional
Font
config
object (Config)
Optional
Config
applied
boolean
Optional
Whether the theme has been applied or not
is_private
boolean
Optional
Whether the theme is private or not
tags
array of string
Optional
An array of tags associated with the theme
_id
string
Optional
The unique identifier of the theme
application_id
string
Optional
The ID of the application
marketplace_theme_id
string
Optional
The ID of the theme in the marketplace
meta
object (ThemeMeta)
Optional
ThemeMeta
name
string
Optional
The name of the theme
template_theme_id
string
Optional
The ID of the template theme
version
string
Optional
The version of the theme
styles
object
Optional
The styles associated with the theme
created_at
string
Optional
The creation timestamp of the theme
updated_at
string
Optional
The last update timestamp of the theme
assets
object (Assets)
Optional
Assets
available_sections
array of object (SectionItem)
Optional
Available sections information
Array of SectionItem
theme_type
string
Optional
Enum
company_id
number
Optional
The company id in which sales channel exists
src
string
Optional
Examples
Parameters
body:
body
Was this section helpful?
PATCH
/service/platform/theme/v2.0/company/{company_id}/application/{application_id}/{theme_id}/name
Loading...
Response
Example response not available.
PATCH

Apply a theme

Change current applied theme with new draft theme.
Parameters
themeId
string
The ID of the apply
Response
200
Theme applied successfully
ThemesSchema
font
object (Font)
Optional
Font
config
object (Config)
Optional
Config
applied
boolean
Optional
Whether the theme has been applied or not
is_private
boolean
Optional
Whether the theme is private or not
tags
array of string
Optional
An array of tags associated with the theme
_id
string
Optional
The unique identifier of the theme
application_id
string
Optional
The ID of the application
marketplace_theme_id
string
Optional
The ID of the theme in the marketplace
meta
object (ThemeMeta)
Optional
ThemeMeta
name
string
Optional
The name of the theme
template_theme_id
string
Optional
The ID of the template theme
version
string
Optional
The version of the theme
styles
object
Optional
The styles associated with the theme
created_at
string
Optional
The creation timestamp of the theme
updated_at
string
Optional
The last update timestamp of the theme
assets
object (Assets)
Optional
Assets
available_sections
array of object (SectionItem)
Optional
Available sections information
Array of SectionItem
theme_type
string
Optional
Enum
company_id
number
Optional
The company id in which sales channel exists
src
string
Optional
Examples
Parameters
themeId:
"648832dcb99296ab200fbaaa"
Was this section helpful?
PATCH
/service/platform/theme/v2.0/company/{company_id}/application/{application_id}/{theme_id}/apply
Loading...
Response
Example response not available.
POST

Duplicate a theme

Create a new copy of an existing theme by theme Id
Parameters
themeId
string
The ID of the theme to be duplicated
Response
200
Resource duplicated successfully
ThemesSchema
font
object (Font)
Optional
Font
config
object (Config)
Optional
Config
applied
boolean
Optional
Whether the theme has been applied or not
is_private
boolean
Optional
Whether the theme is private or not
tags
array of string
Optional
An array of tags associated with the theme
_id
string
Optional
The unique identifier of the theme
application_id
string
Optional
The ID of the application
marketplace_theme_id
string
Optional
The ID of the theme in the marketplace
meta
object (ThemeMeta)
Optional
ThemeMeta
name
string
Optional
The name of the theme
template_theme_id
string
Optional
The ID of the template theme
version
string
Optional
The version of the theme
styles
object
Optional
The styles associated with the theme
created_at
string
Optional
The creation timestamp of the theme
updated_at
string
Optional
The last update timestamp of the theme
assets
object (Assets)
Optional
Assets
available_sections
array of object (SectionItem)
Optional
Available sections information
Array of SectionItem
theme_type
string
Optional
Enum
company_id
number
Optional
The company id in which sales channel exists
src
string
Optional
Examples
Parameters
themeId:
"648832dcb99296ab200fbaaa"
Was this section helpful?
POST
/service/platform/theme/v2.0/company/{company_id}/application/{application_id}/{theme_id}/duplicate
Loading...
Response
Example response not available.
GET

Get applied theme

Retrieve the currently applied theme of a sales channel using application Id.
Parameters
No Parameters
Response
200
Successfully fetch the applied theme
ThemesSchema
font
object (Font)
Optional
Font
config
object (Config)
Optional
Config
applied
boolean
Optional
Whether the theme has been applied or not
is_private
boolean
Optional
Whether the theme is private or not
tags
array of string
Optional
An array of tags associated with the theme
_id
string
Optional
The unique identifier of the theme
application_id
string
Optional
The ID of the application
marketplace_theme_id
string
Optional
The ID of the theme in the marketplace
meta
object (ThemeMeta)
Optional
ThemeMeta
name
string
Optional
The name of the theme
template_theme_id
string
Optional
The ID of the template theme
version
string
Optional
The version of the theme
styles
object
Optional
The styles associated with the theme
created_at
string
Optional
The creation timestamp of the theme
updated_at
string
Optional
The last update timestamp of the theme
assets
object (Assets)
Optional
Assets
available_sections
array of object (SectionItem)
Optional
Available sections information
Array of SectionItem
theme_type
string
Optional
Enum
company_id
number
Optional
The company id in which sales channel exists
src
string
Optional
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/platform/theme/v2.0/company/{company_id}/application/{application_id}
Loading...
Response
Example response not available.
GET

Get theme for preview

Retrieve a theme by its unique identifier. Response contains theme template data and data stored in theme editor.
Parameters
themeId
string
The ID of the theme
Response
200
Get the details of the theme for preview purpose.
ThemesSchema
font
object (Font)
Optional
Font
config
object (Config)
Optional
Config
applied
boolean
Optional
Whether the theme has been applied or not
is_private
boolean
Optional
Whether the theme is private or not
tags
array of string
Optional
An array of tags associated with the theme
_id
string
Optional
The unique identifier of the theme
application_id
string
Optional
The ID of the application
marketplace_theme_id
string
Optional
The ID of the theme in the marketplace
meta
object (ThemeMeta)
Optional
ThemeMeta
name
string
Optional
The name of the theme
template_theme_id
string
Optional
The ID of the template theme
version
string
Optional
The version of the theme
styles
object
Optional
The styles associated with the theme
created_at
string
Optional
The creation timestamp of the theme
updated_at
string
Optional
The last update timestamp of the theme
assets
object (Assets)
Optional
Assets
available_sections
array of object (SectionItem)
Optional
Available sections information
Array of SectionItem
theme_type
string
Optional
Enum
company_id
number
Optional
The company id in which sales channel exists
src
string
Optional
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/platform/theme/v2.0/company/{company_id}/application/{application_id}/{theme_id}/preview
Loading...
Response
Example response not available.
HEAD

Get theme last modified date

Retrieve the last modification of a theme used for polling and identifing cross user changes in a theme.
Parameters
themeId
string
ID allotted to the theme.
Response
200
4XX
5XX
Success. Recieves last modified timestamp in the header.
Header Items
Last-Modified
string
| date
Optional
Last-modified action on Theme
Examples
Parameters
themeId:
"value"
Was this section helpful?
HEAD
/service/platform/theme/v2.0/company/{company_id}/application/{application_id}/{theme_id}/polling
Loading...
Response
Example response not available.
GET

Check theme is upgradable

Determine if a public theme is eligible for an upgrade to a new version after any new version released in marketplace.
Parameters
themeId
string
The ID of the theme
Response
200
Successful response
ThemeUpgradableResponse
upgrade
boolean
Optional
Indicates if the theme is upgradable or not
versions
object (ThemeVersions)
Optional
ThemeVersions
message
string
Optional
A message describing the theme upgrade status
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/platform/theme/v2.0/company/{company_id}/application/{application_id}/{theme_id}/upgradable
Loading...
Response
Example response not available.
PUT

Upgrade theme

Update a draft theme to a new version of the marketplace.
Parameters
themeId
string
The ID of the upgrade
Response
200
Successful upgrade
ThemesSchema
font
object (Font)
Optional
Font
config
object (Config)
Optional
Config
applied
boolean
Optional
Whether the theme has been applied or not
is_private
boolean
Optional
Whether the theme is private or not
tags
array of string
Optional
An array of tags associated with the theme
_id
string
Optional
The unique identifier of the theme
application_id
string
Optional
The ID of the application
marketplace_theme_id
string
Optional
The ID of the theme in the marketplace
meta
object (ThemeMeta)
Optional
ThemeMeta
name
string
Optional
The name of the theme
template_theme_id
string
Optional
The ID of the template theme
version
string
Optional
The version of the theme
styles
object
Optional
The styles associated with the theme
created_at
string
Optional
The creation timestamp of the theme
updated_at
string
Optional
The last update timestamp of the theme
assets
object (Assets)
Optional
Assets
available_sections
array of object (SectionItem)
Optional
Available sections information
Array of SectionItem
theme_type
string
Optional
Enum
company_id
number
Optional
The company id in which sales channel exists
src
string
Optional
Examples
Parameters
Parameters are not required.
Was this section helpful?
PUT
/service/platform/theme/v2.0/company/{company_id}/application/{application_id}/{theme_id}/upgrade
Loading...
Response
Example response not available.

Seller Account Theme

The Seller Account APIs for themes offer comprehensive functionality for managing themes added both publicly through marketplaces and privately. Sellers can seamlessly manage themes. These APIs provide features for theme creation, and deletion, ensuring sellers have full control over their theme portfolio.

Operations
GET
/service/platform/theme/v2.0/company/{company_id}/themes
# List company themes
GET
/service/platform/theme/v2.0/company/{company_id}/private_themes
# List private company themes
POST
/service/platform/theme/v2.0/company/{company_id}
# Create a company theme
DEL
/service/platform/theme/v2.0/company/{company_id}/{theme_id}
# Delete a company theme
GET

List company themes

Retrieve themes added to a company.
Parameters
searchText
string
Optional
Search Text to match the Theme Names and return the response.
Response
200
401
A list of themes for the company.
Array of CompanyThemeSchema
_id
string
Optional
The unique identifier for the theme.
name
string
Optional
The name of the theme.
marketplace_theme_id
object (MarketplaceThemeId)
Optional
MarketplaceThemeId
company_id
integer
Optional
The ID of the company that the theme belongs to.
meta
object (CompanyThemeMeta)
Optional
CompanyThemeMeta
created_at
string
| date-time
Optional
The timestamp when the theme was created.
updated_at
string
| date-time
Optional
The timestamp when the theme was last updated.
applied_themes
array of object (AppliedThemes)
Optional
Array of AppliedThemes
Examples
Parameters
searchText:
"value"
Was this section helpful?
GET
/service/platform/theme/v2.0/company/{company_id}/themes
Loading...
Response
Loading...
GET

List private company themes

Retrieve a list of private themes added to a company.
Parameters
searchText
string
Optional
Search Text to match the Theme Names and return the response.
Response
200
401
A list of Private themes for the company.
Array of CompanyPrivateTheme
theme_type
string
Optional
Type of the theme
_id
string
Optional
Unique identifier for the theme
name
string
Optional
Name of the theme
version
string
Optional
Version of the theme
application_id
string
Optional
Identifier for the application
created_at
string
| date-time
Optional
Date and time when the theme was created
updated_at
string
| date-time
Optional
Date and time when the theme was last updated
applied
boolean
Optional
Whether the theme is applied or not
is_private
boolean
Optional
Whether the theme is private or not
meta
object (CompanyThemeMeta)
Optional
CompanyThemeMeta
Examples
Parameters
searchText:
"value"
Was this section helpful?
GET
/service/platform/theme/v2.0/company/{company_id}/private_themes
Loading...
Response
Loading...
POST

Create a company theme

Incorporate a marketplace theme into a company's profile.
Parameters
body
object (ThemeReq)
ThemeReq
marketplace_theme_id
string
Optional
The ID of the marketplace theme to apply to the company.
Response
200
401
The theme was successfully applied to the company.
CompanyThemeSchema
_id
string
Optional
The unique identifier for the theme.
name
string
Optional
The name of the theme.
marketplace_theme_id
object (MarketplaceThemeId)
Optional
MarketplaceThemeId
company_id
integer
Optional
The ID of the company that the theme belongs to.
meta
object (CompanyThemeMeta)
Optional
CompanyThemeMeta
created_at
string
| date-time
Optional
The timestamp when the theme was created.
updated_at
string
| date-time
Optional
The timestamp when the theme was last updated.
applied_themes
array of object (AppliedThemes)
Optional
Array of AppliedThemes
Examples
Parameters
body:
body
Was this section helpful?
POST
/service/platform/theme/v2.0/company/{company_id}
Loading...
Response
Loading...
DEL

Delete a company theme

Remove a theme associated with a company.
Parameters
themeId
string
The ID of the theme.
Response
200
Theme deleted successfully.
CompanyThemeSchema
_id
string
Optional
The unique identifier for the theme.
name
string
Optional
The name of the theme.
marketplace_theme_id
object (MarketplaceThemeId)
Optional
MarketplaceThemeId
company_id
integer
Optional
The ID of the company that the theme belongs to.
meta
object (CompanyThemeMeta)
Optional
CompanyThemeMeta
created_at
string
| date-time
Optional
The timestamp when the theme was created.
updated_at
string
| date-time
Optional
The timestamp when the theme was last updated.
applied_themes
array of object (AppliedThemes)
Optional
Array of AppliedThemes
Examples
Parameters
themeId:
"value"
Was this section helpful?
DEL
/service/platform/theme/v2.0/company/{company_id}/{theme_id}
Loading...
Response
Loading...

Theme Page

Theme Pages API is a tool for developers to efficiently create dynamic and customizable web pages across various platforms. It offers essential features such as section filtering based on criteria like delivery zones, time scheduler, and type of platforms, it enables developers to configure reusable sections with multiple elements using blocks, fostering creativity and flexibility in design. Moreover, it provides functionality for managing the SEO content of a page. For instance, developers can easily design a homepage with a featured products section and a promotional banner, customizing the content and layout as needed. They can implement filtering based on delivery zones and time scheduler to cater to specific audiences effectively. Ultimately, the UI Theme Pages API empowers developers to craft engaging and optimized user experiences that resonate across platforms.

Operations
GET
/service/platform/theme/v1.0/company/{company_id}/application/{application_id}/{theme_id}/page
# List pages of a theme
POST
/service/platform/theme/v1.0/company/{company_id}/application/{application_id}/{theme_id}/page
# Create theme page
PUT
/service/platform/theme/v1.0/company/{company_id}/application/{application_id}/{theme_id}/page
# Update theme pages
GET
/service/platform/theme/v1.0/company/{company_id}/application/{application_id}/{theme_id}/{page_value}
# Get a page
PUT
/service/platform/theme/v1.0/company/{company_id}/application/{application_id}/{theme_id}/{page_value}
# Update a page
DEL
/service/platform/theme/v1.0/company/{company_id}/application/{application_id}/{theme_id}/{page_value}
# Delete a page
GET

List pages of a theme

Retrieve a list of all available pages.
Parameters
themeId
string
ID of the theme to be retrieved
Response
200
4XX
5XX
Success. Returns an array all the pages of the theme. Refer `AllAvailablePageSchema` for more details.
AllAvailablePageSchema
pages
array of object (AvailablePageSchema)
Optional
Array of AvailablePageSchema
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/platform/theme/v1.0/company/{company_id}/application/{application_id}/{theme_id}/page
Loading...
Response
Example response not available.
POST

Create theme page

Generate and add a new page to the selected theme of the Platform.
Parameters
themeId
string
ID of the theme
body
object (AvailablePageSchema)
AvailablePageSchema
value
string
Optional
text
string
Optional
path
string
Optional
type
string
Optional
Enum
sections
array of object (AvailablePageSchemaSections)
Optional
Array of AvailablePageSchemaSections
sections_meta
array of object (AvailablePageSectionMetaAttributes)
Optional
Array of AvailablePageSectionMetaAttributes
theme
string
Optional
seo
object (AvailablePageSeo)
Optional
AvailablePageSeo
props
array of object
Optional
_id
string
Optional
created_at
string
Optional
The creation timestamp of the page
updated_at
string
Optional
The last update timestamp of the page
Response
200
4XX
5XX
Success. Returns the page of the theme. Refer `AvailablePageSchema` for more details.
AvailablePageSchema
value
string
Optional
text
string
Optional
path
string
Optional
type
string
Optional
Enum
sections
array of object (AvailablePageSchemaSections)
Optional
Array of AvailablePageSchemaSections
sections_meta
array of object (AvailablePageSectionMetaAttributes)
Optional
Array of AvailablePageSectionMetaAttributes
theme
string
Optional
seo
object (AvailablePageSeo)
Optional
AvailablePageSeo
props
array of object
Optional
_id
string
Optional
created_at
string
Optional
The creation timestamp of the page
updated_at
string
Optional
The last update timestamp of the page
Examples
Parameters
Parameters are not required.
Was this section helpful?
POST
/service/platform/theme/v1.0/company/{company_id}/application/{application_id}/{theme_id}/page
Loading...
Response
Example response not available.
PUT

Update theme pages

Modify multiple pages simultaneously of a theme.
Parameters
themeId
string
ID of the theme to be retrieved
body
object (AllAvailablePageSchema)
AllAvailablePageSchema
pages
array of object (AvailablePageSchema)
Optional
Array of AvailablePageSchema
Response
200
4XX
5XX
Success. Returns an array all the pages of the theme. Refer `AllAvailablePageSchema` for more details.
AllAvailablePageSchema
pages
array of object (AvailablePageSchema)
Optional
Array of AvailablePageSchema
Examples
Parameters
Parameters are not required.
Was this section helpful?
PUT
/service/platform/theme/v1.0/company/{company_id}/application/{application_id}/{theme_id}/page
Loading...
Response
Example response not available.
GET

Get a page

Retrieve detailed information about a specific page of a theme.
Parameters
themeId
string
ID of the theme to be retrieved
pageValue
string
Value of the page to be retrieved
Response
200
4XX
5XX
Success. Returns an object of the page. Refer `AvailablePageSchema` for more details.
AvailablePageSchema
value
string
Optional
text
string
Optional
path
string
Optional
type
string
Optional
Enum
sections
array of object (AvailablePageSchemaSections)
Optional
Array of AvailablePageSchemaSections
sections_meta
array of object (AvailablePageSectionMetaAttributes)
Optional
Array of AvailablePageSectionMetaAttributes
theme
string
Optional
seo
object (AvailablePageSeo)
Optional
AvailablePageSeo
props
array of object
Optional
_id
string
Optional
created_at
string
Optional
The creation timestamp of the page
updated_at
string
Optional
The last update timestamp of the page
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/platform/theme/v1.0/company/{company_id}/application/{application_id}/{theme_id}/{page_value}
Loading...
Response
Example response not available.
PUT

Update a page

Modify and update the content of a page.
Parameters
themeId
string
ID of the theme
pageValue
string
Value of the page to be updated
body
object (AvailablePageSchema)
AvailablePageSchema
value
string
Optional
text
string
Optional
path
string
Optional
type
string
Optional
Enum
sections
array of object (AvailablePageSchemaSections)
Optional
Array of AvailablePageSchemaSections
sections_meta
array of object (AvailablePageSectionMetaAttributes)
Optional
Array of AvailablePageSectionMetaAttributes
theme
string
Optional
seo
object (AvailablePageSeo)
Optional
AvailablePageSeo
props
array of object
Optional
_id
string
Optional
created_at
string
Optional
The creation timestamp of the page
updated_at
string
Optional
The last update timestamp of the page
Response
200
4XX
5XX
Success. Returns a the page of the theme. Refer `AvailablePageSchema` for more details.
AvailablePageSchema
value
string
Optional
text
string
Optional
path
string
Optional
type
string
Optional
Enum
sections
array of object (AvailablePageSchemaSections)
Optional
Array of AvailablePageSchemaSections
sections_meta
array of object (AvailablePageSectionMetaAttributes)
Optional
Array of AvailablePageSectionMetaAttributes
theme
string
Optional
seo
object (AvailablePageSeo)
Optional
AvailablePageSeo
props
array of object
Optional
_id
string
Optional
created_at
string
Optional
The creation timestamp of the page
updated_at
string
Optional
The last update timestamp of the page
Examples
Parameters
Parameters are not required.
Was this section helpful?
PUT
/service/platform/theme/v1.0/company/{company_id}/application/{application_id}/{theme_id}/{page_value}
Loading...
Response
Example response not available.
DEL

Delete a page

Remove a page from a theme of the platform.
Parameters
themeId
string
ID of the theme
pageValue
string
Value of the page to be updated
Response
200
4XX
5XX
Success. Returns a the page of the theme. Refer `AvailablePageSchema` for more details.
AvailablePageSchema
value
string
Optional
text
string
Optional
path
string
Optional
type
string
Optional
Enum
sections
array of object (AvailablePageSchemaSections)
Optional
Array of AvailablePageSchemaSections
sections_meta
array of object (AvailablePageSectionMetaAttributes)
Optional
Array of AvailablePageSectionMetaAttributes
theme
string
Optional
seo
object (AvailablePageSeo)
Optional
AvailablePageSeo
props
array of object
Optional
_id
string
Optional
created_at
string
Optional
The creation timestamp of the page
updated_at
string
Optional
The last update timestamp of the page
Examples
Parameters
Parameters are not required.
Was this section helpful?
DEL
/service/platform/theme/v1.0/company/{company_id}/application/{application_id}/{theme_id}/{page_value}
Loading...
Response
Example response not available.