Theme
API endpoints for bulk create and update operations on theme sections
Oversee the extension sections in your application through the CLI. This includes obtaining draft extension sections, publishing extension sections, retrieving sections of extensions, and more.
Operations
GET
# Get extension sections
FDK Method Name: getExtensionSections
Retrieve the list of extension sections for a given application in the specified company.
Parameters
company_id
integer
Required
The ID of the company
application_id
string
Required
The ID of the application
type
string
The type of the theme
company_mode
string
The mode of the company
Response
200
Successfully retrieved the list of extension sections.
Array of GetExtensionSectionRes
extension_id
string
Extension ID
bundle_name
string
Bundle name
organization_id
string
Organization ID
sections
array of object (ExtensionSection)
Sections
Array of ExtensionSection
label
string
Display label for the section.
name
string
Section name/slug.
props
array of object (PropExtension)
Section property definitions.
Array of PropExtension
id
string
Property identifier.
label
string
Display label for the property.
type
string
Property type (e.g. text).
info
string
Additional info or hint for the property.
blocks
array of object
Blocks within the section.
assets
object (AssetsExtension)
AssetsExtension
js
string
URL of the JavaScript bundle.
css
string
URL of the CSS bundle.
status
string
Status
type
string
Extension type (e.g. react).
created_at
string
| date-time
Timestamp when the extension section was created.
updated_at
string
| date-time
Timestamp when the extension section was last updated.
Examples
Parameters
company_id:
1
application_id:
"6399ba8924ab1be7c21314b5"
type:
"react"
company_mode:
"live"
Was this section helpful?
GET
Response
Get extension sections
getExtensionSections
Global Sections Management API provides comprehensive tools for managing global sections within themes. These APIs enable platform users to create draft versions from approved global sections, allowing for safe editing and testing of global components that appear across multiple pages. The APIs handle concurrent access, draft creation, and status management to ensure consistency and reliability in theme global section workflows. This functionality is essential for managing global elements like headers, footers, navigation bars, and other shared components that need to maintain consistency across an entire application while allowing for controlled updates and modifications through a draft-approval process.
Operations
GET
# List global sections for a theme
PUT
# Update global section status (approve/reject)
FDK Method Name: listGlobalSections
Retrieves a paginated list of global sections for a specific theme with lock information for concurrent editing management. This endpoint provides comprehensive section data including status, configuration, and real-time lock status for collaborative editing.
Parameters
company_id
integer
Required
ID of the company that owns the application.
application_id
string
Required
ID of the application that contains the theme.
theme_id
string
Required
ID of the theme to list global sections for.
page_no
integer
| value >= 1
Page number for pagination (1-based).
Default Value : 1
page_size
integer
| value >= 1
| value <= 100
Number of items per page.
Default Value : 20
status
string
Filter global sections by status.
Enum
Response
200
Success. Returns a paginated list of global sections with lock information.
GlobalSectionList
success
boolean
Indicates if the request was successful
status_counts
object (GlobalSectionStatusCounts)
GlobalSectionStatusCounts
draft
integer
Number of sections in draft status
pending_for_approval
integer
Number of sections pending approval
approved
integer
Number of sections approved
rejected
integer
Number of sections rejected
all
integer
Total number of sections
page
integer
Current page number
page_size
integer
Number of items per page
total
integer
Total number of items
data
array of object (GlobalSection)
List of global sections for the current page
Array of GlobalSection
_id
string
Unique identifier of the global section
application_id
string
ID of the application this section belongs to
theme_id
string
ID of the theme this section belongs to
section
object (GlobalSectionSectionUpdate)
GlobalSectionSectionUpdate
_id
string
ID of the section
name
string
Name of the section
label
string
Display label for the section
props
object (SectionProps)
SectionProps
title
object (TextProp)
TextProp
value
string
The value of the text property.
type
string
The type of the property.
item_margin
object (TextProp)
TextProp
value
string
The value of the text property.
type
string
The type of the property.
autoplay
object (CheckboxProp)
CheckboxProp
value
boolean
The value of the checkbox property.
type
string
The type of the property.
slide_interval
object (RangeProp)
RangeProp
value
integer
The value of the range property.
type
string
The type of the property.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
blocks
array of object
Array of blocks within the section
__source
object (SourceMeta)
SourceMeta
type
string
Source type
Default Value : themeBundle
Enum
id
string
Identifier of the source entity
bundle_name
string
Human-readable bundle name if applicable
global_reference
string
Reference to the global section ID
Pattern : ^[0-9a-fA-F]{24}$
preset
object
Preset configuration for the section
predicate
object (SectionPredicate)
SectionPredicate
screen
object (SectionScreenPredicate)
SectionScreenPredicate
mobile
boolean
Whether to enable on mobile screens.
desktop
boolean
Whether to enable on desktop screens.
tablet
boolean
Whether to enable on tablet screens.
user
object (SectionUserPredicate)
SectionUserPredicate
user_type
string
High-level audience bucket (e.g., "all_user").
Enum
user_groups
object (SectionUserGroups)
SectionUserGroups
l1
object (UserGroupInEx)
UserGroupInEx
includes
array of string
Group identifiers explicitly included.
excludes
array of string
Group identifiers explicitly excluded.
l2
object (UserGroupInEx)
UserGroupInEx
includes
array of string
Group identifiers explicitly included.
excludes
array of string
Group identifiers explicitly excluded.
user_login_status
object (UserGroupsUserLoginStatusPredicate)
UserGroupsUserLoginStatusPredicate
selected
boolean
Whether to combine the user groups filter with the login status filter.
login_status
boolean
Whether the predicate targets logged-in users (true) or logged-out users (false).
user_status
object (UserStatusPredicate)
UserStatusPredicate
new_user
boolean
Whether to enable on new users.
existing_user
boolean
Whether to enable on existing users
route
object (SectionRoutePredicate)
SectionRoutePredicate
selected
string
Route selection mode (e.g., "none" to disable route constraint).
exact_url
string
Exact URL to match when `selected` is configured accordingly.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
platform
object (SectionPlatformPredicate)
SectionPlatformPredicate
ios
boolean
Whether to enable on iOS app.
android
boolean
Whether to enable on Android app.
web
boolean
Whether to enable on Web.
theme_zones
object (ThemeZones)
ThemeZones
type
string
Zone type (implementation-defined, e.g., "state", "zone_list", etc.).
zones
object (IncludeExcludeStateCityZone)
IncludeExcludeStateCityZone
include
array of string
State/city identifiers explicitly included.
exclude
array of string
State/city identifiers explicitly excluded.
states
object (IncludeExcludeStateCityZone)
IncludeExcludeStateCityZone
include
array of string
State/city identifiers explicitly included.
exclude
array of string
State/city identifiers explicitly excluded.
cities
object (IncludeExcludeStateCityZone)
IncludeExcludeStateCityZone
include
array of string
State/city identifiers explicitly included.
exclude
array of string
State/city identifiers explicitly excluded.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
experimental_features
array of string
Optional list of experimental features.
schedule
array of object
Optional list of scheduling rules; empty array means always active.
user_status
object (UserStatusPredicate)
UserStatusPredicate
new_user
boolean
Whether to enable on new users.
existing_user
boolean
Whether to enable on existing users
status
string
Status of the section
Enum
comment
string
Optional comment for the section
updated_by
string
ID of the user who last updated the section
updated_at
string
| date-time
Timestamp of last update
created_at
string
| date-time
Timestamp of creations
is_deleted
boolean
Soft delete flag
Default Value : false
default_sections
object
Default section configuration and schema
created_at
string
| date-time
Timestamp when the section was created
updated_at
string
| date-time
Timestamp when the section was last updated
lock
object (GlobalSectionLock)
Nullable
GlobalSectionLock
user
object (GlobalSectionLockUser)
GlobalSectionLockUser
id
string
ID of the user holding the lock
name
string
Name of the user holding the lock
locked_at
string
| date-time
When the lock was acquired
last_activity
string
| date-time
When the lock will expire
theme_id
string
Theme id for context
socket_id
string
Socket id for context
global_section_id
string
Global section id for context
Examples
Parameters
company_id:
123
application_id:
"000000000000000000000001"
theme_id:
"000000000000000000000001"
Was this section helpful?
GET
Response
List global sections for a theme
listGlobalSections
FDK Method Name: updateGlobalSectionStatus
Approves or rejects a global section currently in pending_for_approval status. This route is protected by a lock check; if the section is locked by another user, the request is blocked. Allowed actions: approve, reject.
Parameters
company_id
integer
Required
ID of the company that owns the application.
application_id
string
Required
ID of the application that contains the theme.
theme_id
string
Required
ID of the theme the section belongs to.
global_section_id
string
Required
ID of the global section to update status for.
action
string
Required
Status action to apply.
Enum
Request body
comment
string
Optional comment to record with the status change.
Response
200
Status updated successfully
GlobalSection
_id
string
Unique identifier of the global section
application_id
string
ID of the application this section belongs to
theme_id
string
ID of the theme this section belongs to
section
object (GlobalSectionSectionUpdate)
GlobalSectionSectionUpdate
_id
string
ID of the section
name
string
Name of the section
label
string
Display label for the section
props
object (SectionProps)
SectionProps
title
object (TextProp)
TextProp
value
string
The value of the text property.
type
string
The type of the property.
item_margin
object (TextProp)
TextProp
value
string
The value of the text property.
type
string
The type of the property.
autoplay
object (CheckboxProp)
CheckboxProp
value
boolean
The value of the checkbox property.
type
string
The type of the property.
slide_interval
object (RangeProp)
RangeProp
value
integer
The value of the range property.
type
string
The type of the property.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
blocks
array of object
Array of blocks within the section
__source
object (SourceMeta)
SourceMeta
type
string
Source type
Default Value : themeBundle
Enum
id
string
Identifier of the source entity
bundle_name
string
Human-readable bundle name if applicable
global_reference
string
Reference to the global section ID
Pattern : ^[0-9a-fA-F]{24}$
preset
object
Preset configuration for the section
predicate
object (SectionPredicate)
SectionPredicate
screen
object (SectionScreenPredicate)
SectionScreenPredicate
mobile
boolean
Whether to enable on mobile screens.
desktop
boolean
Whether to enable on desktop screens.
tablet
boolean
Whether to enable on tablet screens.
user
object (SectionUserPredicate)
SectionUserPredicate
user_type
string
High-level audience bucket (e.g., "all_user").
Enum
user_groups
object (SectionUserGroups)
SectionUserGroups
l1
object (UserGroupInEx)
UserGroupInEx
includes
array of string
Group identifiers explicitly included.
excludes
array of string
Group identifiers explicitly excluded.
l2
object (UserGroupInEx)
UserGroupInEx
includes
array of string
Group identifiers explicitly included.
excludes
array of string
Group identifiers explicitly excluded.
user_login_status
object (UserGroupsUserLoginStatusPredicate)
UserGroupsUserLoginStatusPredicate
selected
boolean
Whether to combine the user groups filter with the login status filter.
login_status
boolean
Whether the predicate targets logged-in users (true) or logged-out users (false).
user_status
object (UserStatusPredicate)
UserStatusPredicate
new_user
boolean
Whether to enable on new users.
existing_user
boolean
Whether to enable on existing users
route
object (SectionRoutePredicate)
SectionRoutePredicate
selected
string
Route selection mode (e.g., "none" to disable route constraint).
exact_url
string
Exact URL to match when `selected` is configured accordingly.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
platform
object (SectionPlatformPredicate)
SectionPlatformPredicate
ios
boolean
Whether to enable on iOS app.
android
boolean
Whether to enable on Android app.
web
boolean
Whether to enable on Web.
theme_zones
object (ThemeZones)
ThemeZones
type
string
Zone type (implementation-defined, e.g., "state", "zone_list", etc.).
zones
object (IncludeExcludeStateCityZone)
IncludeExcludeStateCityZone
include
array of string
State/city identifiers explicitly included.
exclude
array of string
State/city identifiers explicitly excluded.
states
object (IncludeExcludeStateCityZone)
IncludeExcludeStateCityZone
include
array of string
State/city identifiers explicitly included.
exclude
array of string
State/city identifiers explicitly excluded.
cities
object (IncludeExcludeStateCityZone)
IncludeExcludeStateCityZone
include
array of string
State/city identifiers explicitly included.
exclude
array of string
State/city identifiers explicitly excluded.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
experimental_features
array of string
Optional list of experimental features.
schedule
array of object
Optional list of scheduling rules; empty array means always active.
user_status
object (UserStatusPredicate)
UserStatusPredicate
new_user
boolean
Whether to enable on new users.
existing_user
boolean
Whether to enable on existing users
status
string
Status of the section
Enum
comment
string
Optional comment for the section
updated_by
string
ID of the user who last updated the section
updated_at
string
| date-time
Timestamp of last update
created_at
string
| date-time
Timestamp of creations
is_deleted
boolean
Soft delete flag
Default Value : false
default_sections
object
Default section configuration and schema
created_at
string
| date-time
Timestamp when the section was created
updated_at
string
| date-time
Timestamp when the section was last updated
lock
object (GlobalSectionLock)
Nullable
GlobalSectionLock
user
object (GlobalSectionLockUser)
GlobalSectionLockUser
id
string
ID of the user holding the lock
name
string
Name of the user holding the lock
locked_at
string
| date-time
When the lock was acquired
last_activity
string
| date-time
When the lock will expire
theme_id
string
Theme id for context
socket_id
string
Socket id for context
global_section_id
string
Global section id for context
Examples
Parameters
company_id:
1
application_id:
"000000000000000000000001"
theme_id:
"000000000000000000000001"
global_section_id:
"647abc789abc123456789016"
action:
"approve"
body:
body
Was this section helpful?
PUT
Response
Update global section status (approve/reject)
updateGlobalSectionStatus
Page Mapper is a feature which enables to dynamically set different page content on a single slug based on various attributes such as user, schedule and theme zones
Operations
GET
# Get Page Mapper Configuration
PUT
# Update Page Mapper Configuration
FDK Method Name: getPageMapperConfig
Retrieve the page mapper configuration for a specific application within a company.
Parameters
company_id
string
Required
Numeric ID allotted to a business account on Fynd Platform.
application_id
string
Required
ID of the application within the business account.
Response
200
Success. Page Mapper information returned.
PageMapperSchema
_id
string
Unique identifier for the resource
application_id
string
Identifier of the application to which this resource belongs
created_at
string
| date-time
Timestamp when the resource was created
enabled
boolean
Flag indicating whether the resource is enabled or disabled
updated_at
string
| date-time
Timestamp when the resource was last updated
Examples
Parameters
company_id:
"1"
application_id:
"66500a1f0e79b842c8f17c21"
Was this section helpful?
GET
Response
Get Page Mapper Configuration
getPageMapperConfig
FDK Method Name: updatePageMapperConfig
Update the `enabled` status of the page mapper for a specific application.
Parameters
company_id
string
Required
Numeric ID allotted to a business account on Fynd Platform.
application_id
string
Required
ID of the application within the business account.
Request body
enabled
boolean
Required
Whether the Page Mapper is enabled or disabled
Response
200
Success. Updated Page Mapper info returned.
PageMapperSchema
_id
string
Unique identifier for the resource
application_id
string
Identifier of the application to which this resource belongs
created_at
string
| date-time
Timestamp when the resource was created
enabled
boolean
Flag indicating whether the resource is enabled or disabled
updated_at
string
| date-time
Timestamp when the resource was last updated
Examples
Parameters
company_id:
"1"
application_id:
"66500a2a7b442d2e7a9a9e14"
body:
body
Was this section helpful?
PUT
Response
Update Page Mapper Configuration
updatePageMapperConfig
Operations
GET
# Get unified sections for a theme
GET
# List theme fonts
PATCH
# Update theme name
POST
# Get Create theme
GET
# Get applied theme
GET
# Get latest version of theme by slug.
POST
# Create a new global section
PUT
# Update global section by ID
POST
# Bulk create sections
PUT
# Bulk update sections
FDK Method Name: getUnifiedSections
Unified API endpoint that returns theme data with three separate section groups: 1. extension_sections - Sections from installed extensions 2. available_sections - Default sections from template theme 3. global_sections - Custom global sections for the theme
Supports filtering by type, company_mode (live/development), and search query to filter sections by label.
Parameters
company_id
integer
Required
The ID of the company that owns the application.
application_id
string
Required
The ID of the application that contains the theme.
theme_id
string
Required
The ID of the theme to fetch sections for.
type
string
Theme type filter for extension sections.
company_mode
string
Company mode filter for extension sections.
search
string
Search query to filter sections by label.
Response
200
Successfully retrieved unified sections for the theme.
AvailableGlobalExtensionSectionsSchema
font
object (Font)
Font
variants
object (FontVariants)
FontVariants
light
object (FontVariant)
FontVariant
name
string
The name of the font variant
file
string
The URL of the font file
regular
object (FontVariant)
FontVariant
name
string
The name of the font variant
file
string
The URL of the font file
medium
object (FontVariant)
FontVariant
name
string
The name of the font variant
file
string
The URL of the font file
semi_bold
object (FontVariant)
FontVariant
name
string
The name of the font variant
file
string
The URL of the font file
bold
object (FontVariant)
FontVariant
name
string
The name of the font variant
file
string
The URL of the font file
family
string
The font family
config
object (Config)
Config
current
string
The current configuration
list
array of object (ThemeConfiguration)
A list of configurations
Array of ThemeConfiguration
name
string
The name of the configuration
global_config
object
Global configuration key-value pairs for this theme config.
page
array of object (ThemeConfigListPage)
An array of pages
Array of ThemeConfigListPage
page
string
Name of the page
settings
object (ThemeConfigListPageSettingsProps)
ThemeConfigListPageSettingsProps
props
object
Page settings key-value pairs.
global_schema
object (GlobalSchema)
GlobalSchema
props
array of object
List of global property definitions.
preset
object
An Object of default theme configurations
applied
boolean
Whether the theme has been applied or not
is_private
boolean
Whether the theme is private or not
tags
array of string
An array of tags associated with the theme
_id
string
The unique identifier of the theme
application_id
string
The ID of the application
marketplace_theme_id
string
The ID of the theme in the marketplace
meta
object (ThemeMeta)
ThemeMeta
payment
object (ThemePayment)
ThemePayment
is_paid
boolean
Whether the theme is a paid theme.
amount
number
The amount to be paid for the theme.
description
string
The description of the theme
industry
array of string
An array of industries associated with the theme
release
object (Release)
Release
notes
string
The release notes of the theme
version
string
The version of the theme
images
object (Images)
Images
desktop
string
The URL of the desktop image
mobile
string
The URL of the mobile image
slug
string
The slug of the theme
name
string
The name of the theme
name
string
The name of the theme
template_theme_id
string
The ID of the template theme
version
string
The version of the theme
styles
object
The styles associated with the theme
created_at
string
| date-time
The creation timestamp of the theme
updated_at
string
| date-time
The last update timestamp of the theme
global_sections
array of object
Global sections associated with the theme
assets
object (Assets)
Assets
umd_js
object (UMDJs)
UMDJs
link
string
Single UMD JS asset URL.
links
array of string
List of UMD JS asset URLs.
common_js
object (CommonJS)
CommonJS
link
string
CommonJS asset URL.
css
object (CSS)
CSS
link
string
Single CSS asset URL.
links
array of string
List of CSS asset URLs.
available_sections
array of object (SectionItem)
Available sections information
Array of SectionItem
props
array of object
Section property definitions.
blocks
array of object
Blocks
name
string
Name of the section
preset
object (SectionPreset)
SectionPreset
blocks
array of object (Block)
List of blocks in this preset.
Array of Block
type
string
The type of the block.
name
string
The name of the block.
props
object (BlockProps)
BlockProps
image
object (ImagePickerProp)
ImagePickerProp
type
string
The type of the property.
value
string
The value of the image picker property.
slide_link
object (UrlProp)
UrlProp
type
string
The type of the property.
value
string
The value of the URL property.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
label
string
Label for the section
extension_sections
array of object (GetExtensionSectionRes)
Extension sections information
Array of GetExtensionSectionRes
extension_id
string
Extension ID
bundle_name
string
Bundle name
organization_id
string
Organization ID
sections
array of object (ExtensionSection)
Sections
Array of ExtensionSection
label
string
Display label for the section.
name
string
Section name/slug.
props
array of object (PropExtension)
Section property definitions.
Array of PropExtension
id
string
Property identifier.
label
string
Display label for the property.
type
string
Property type (e.g. text).
info
string
Additional info or hint for the property.
blocks
array of object
Blocks within the section.
assets
object (AssetsExtension)
AssetsExtension
js
string
URL of the JavaScript bundle.
css
string
URL of the CSS bundle.
status
string
Status
type
string
Extension type (e.g. react).
created_at
string
| date-time
Timestamp when the extension section was created.
updated_at
string
| date-time
Timestamp when the extension section was last updated.
theme_type
string
Type of the Theme
Enum
company_id
number
The company id in which sales channel exists
src
string
applied_themes
array of object
Applied themes array
Examples
Parameters
company_id:
123
application_id:
"000000000000000000000001"
theme_id:
"000000000000000000000001"
type:
"react"
company_mode:
"live"
Was this section helpful?
GET
Response
Get unified sections for a theme
getUnifiedSections
FDK Method Name: getFontsV2
Retrieve a list of available fonts that can be used by themes in the platform.
Parameters
company_id
integer
Required
Numeric ID allotted to a business account on Fynd Platform.
application_id
string
Required
Alphanumeric ID allotted to an application created within a business account.
Response
200
Success. Refer `FontsSchema` for more details.
FontsSchema
items
array of object
List of font definitions.
kind
string
Response kind (e.g. webfonts#webfontList).
Examples
Parameters
company_id:
123
application_id:
"000000000000000000000001"
Was this section helpful?
GET
Response
List theme fonts
getFontsV2
FDK Method Name: updateThemeName
Modify the name of the draft theme by theme Id.
Parameters
company_id
integer
Required
The ID of the company.
application_id
string
Required
The ID of the application.
theme_id
string
Required
The ID of the theme to be updated.
Request body
name
string
The new name of the theme.
Response
200
400
Theme name updated successfully.
ThemesSchema
font
object (Font)
Font
variants
object (FontVariants)
FontVariants
light
object (FontVariant)
FontVariant
name
string
The name of the font variant
file
string
The URL of the font file
regular
object (FontVariant)
FontVariant
name
string
The name of the font variant
file
string
The URL of the font file
medium
object (FontVariant)
FontVariant
name
string
The name of the font variant
file
string
The URL of the font file
semi_bold
object (FontVariant)
FontVariant
name
string
The name of the font variant
file
string
The URL of the font file
bold
object (FontVariant)
FontVariant
name
string
The name of the font variant
file
string
The URL of the font file
family
string
The font family
config
object (Config)
Config
current
string
The current configuration
list
array of object (ThemeConfiguration)
A list of configurations
Array of ThemeConfiguration
name
string
The name of the configuration
global_config
object
Global configuration key-value pairs for this theme config.
page
array of object (ThemeConfigListPage)
An array of pages
Array of ThemeConfigListPage
page
string
Name of the page
settings
object (ThemeConfigListPageSettingsProps)
ThemeConfigListPageSettingsProps
props
object
Page settings key-value pairs.
global_schema
object (GlobalSchema)
GlobalSchema
props
array of object
List of global property definitions.
preset
object
An Object of default theme configurations
applied
boolean
Whether the theme has been applied or not
is_private
boolean
Whether the theme is private or not
tags
array of string
An array of tags associated with the theme
_id
string
The unique identifier of the theme
application_id
string
The ID of the application
marketplace_theme_id
string
The ID of the theme in the marketplace
meta
object (ThemeMeta)
ThemeMeta
payment
object (ThemePayment)
ThemePayment
is_paid
boolean
Whether the theme is a paid theme.
amount
number
The amount to be paid for the theme.
description
string
The description of the theme
industry
array of string
An array of industries associated with the theme
release
object (Release)
Release
notes
string
The release notes of the theme
version
string
The version of the theme
images
object (Images)
Images
desktop
string
The URL of the desktop image
mobile
string
The URL of the mobile image
slug
string
The slug of the theme
name
string
The name of the theme
name
string
The name of the theme
template_theme_id
string
The ID of the template theme
version
string
The version of the theme
styles
object
The styles associated with the theme
created_at
string
| date-time
The creation timestamp of the theme
updated_at
string
| date-time
The last update timestamp of the theme
global_sections
array of object
Global sections associated with the theme
assets
object (Assets)
Assets
umd_js
object (UMDJs)
UMDJs
link
string
Single UMD JS asset URL.
links
array of string
List of UMD JS asset URLs.
common_js
object (CommonJS)
CommonJS
link
string
CommonJS asset URL.
css
object (CSS)
CSS
link
string
Single CSS asset URL.
links
array of string
List of CSS asset URLs.
available_sections
array of object (SectionItem)
Available sections information
Array of SectionItem
props
array of object
Section property definitions.
blocks
array of object
Blocks
name
string
Name of the section
preset
object (SectionPreset)
SectionPreset
blocks
array of object (Block)
List of blocks in this preset.
Array of Block
type
string
The type of the block.
name
string
The name of the block.
props
object (BlockProps)
BlockProps
image
object (ImagePickerProp)
ImagePickerProp
type
string
The type of the property.
value
string
The value of the image picker property.
slide_link
object (UrlProp)
UrlProp
type
string
The type of the property.
value
string
The value of the URL property.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
label
string
Label for the section
theme_type
string
Type of the Theme
Enum
company_id
number
The company id in which sales channel exists
src
string
URL of the theme source or archive.
applied_themes
array of object
Applied themes array
Examples
Parameters
company_id:
123
application_id:
"000000000000000000000001"
theme_id:
"000000000000000000000001"
body:
body
Was this section helpful?
PATCH
Response
Update theme name
updateThemeName
Parameters
company_id
integer
Required
The ID of the company
application_id
string
Required
The ID of the application
Request body
marketplace_theme_id
string
Theme id of the marketplace
Response
200
Successfully fetch the create theme
ThemesSchema
font
object (Font)
Font
variants
object (FontVariants)
FontVariants
light
object (FontVariant)
FontVariant
name
string
The name of the font variant
file
string
The URL of the font file
regular
object (FontVariant)
FontVariant
name
string
The name of the font variant
file
string
The URL of the font file
medium
object (FontVariant)
FontVariant
name
string
The name of the font variant
file
string
The URL of the font file
semi_bold
object (FontVariant)
FontVariant
name
string
The name of the font variant
file
string
The URL of the font file
bold
object (FontVariant)
FontVariant
name
string
The name of the font variant
file
string
The URL of the font file
family
string
The font family
config
object (Config)
Config
current
string
The current configuration
list
array of object (ThemeConfiguration)
A list of configurations
Array of ThemeConfiguration
name
string
The name of the configuration
global_config
object
Global configuration key-value pairs for this theme config.
page
array of object (ThemeConfigListPage)
An array of pages
Array of ThemeConfigListPage
page
string
Name of the page
settings
object (ThemeConfigListPageSettingsProps)
ThemeConfigListPageSettingsProps
props
object
Page settings key-value pairs.
global_schema
object (GlobalSchema)
GlobalSchema
props
array of object
List of global property definitions.
preset
object
An Object of default theme configurations
applied
boolean
Whether the theme has been applied or not
is_private
boolean
Whether the theme is private or not
tags
array of string
An array of tags associated with the theme
_id
string
The unique identifier of the theme
application_id
string
The ID of the application
marketplace_theme_id
string
The ID of the theme in the marketplace
meta
object (ThemeMeta)
ThemeMeta
payment
object (ThemePayment)
ThemePayment
is_paid
boolean
Whether the theme is a paid theme.
amount
number
The amount to be paid for the theme.
description
string
The description of the theme
industry
array of string
An array of industries associated with the theme
release
object (Release)
Release
notes
string
The release notes of the theme
version
string
The version of the theme
images
object (Images)
Images
desktop
string
The URL of the desktop image
mobile
string
The URL of the mobile image
slug
string
The slug of the theme
name
string
The name of the theme
name
string
The name of the theme
template_theme_id
string
The ID of the template theme
version
string
The version of the theme
styles
object
The styles associated with the theme
created_at
string
| date-time
The creation timestamp of the theme
updated_at
string
| date-time
The last update timestamp of the theme
global_sections
array of object
Global sections associated with the theme
assets
object (Assets)
Assets
umd_js
object (UMDJs)
UMDJs
link
string
Single UMD JS asset URL.
links
array of string
List of UMD JS asset URLs.
common_js
object (CommonJS)
CommonJS
link
string
CommonJS asset URL.
css
object (CSS)
CSS
link
string
Single CSS asset URL.
links
array of string
List of CSS asset URLs.
available_sections
array of object (SectionItem)
Available sections information
Array of SectionItem
props
array of object
Section property definitions.
blocks
array of object
Blocks
name
string
Name of the section
preset
object (SectionPreset)
SectionPreset
blocks
array of object (Block)
List of blocks in this preset.
Array of Block
type
string
The type of the block.
name
string
The name of the block.
props
object (BlockProps)
BlockProps
image
object (ImagePickerProp)
ImagePickerProp
type
string
The type of the property.
value
string
The value of the image picker property.
slide_link
object (UrlProp)
UrlProp
type
string
The type of the property.
value
string
The value of the URL property.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
label
string
Label for the section
theme_type
string
Type of the Theme
Enum
company_id
number
The company id in which sales channel exists
src
string
URL of the theme source or archive.
applied_themes
array of object
Applied themes array
Examples
Parameters
company_id:
19243
application_id:
"000000000000000000000001"
body:
body
Was this section helpful?
POST
Response
Get Create theme
createTheme
FDK Method Name: getAppliedTheme
Retrieve the currently applied theme of a sales channel using application Id.
Parameters
company_id
integer
Required
The ID of the company
application_id
string
Required
The ID of the application
Response
200
Successfully fetch the applied theme
ThemesSchema
font
object (Font)
Font
variants
object (FontVariants)
FontVariants
light
object (FontVariant)
FontVariant
name
string
The name of the font variant
file
string
The URL of the font file
regular
object (FontVariant)
FontVariant
name
string
The name of the font variant
file
string
The URL of the font file
medium
object (FontVariant)
FontVariant
name
string
The name of the font variant
file
string
The URL of the font file
semi_bold
object (FontVariant)
FontVariant
name
string
The name of the font variant
file
string
The URL of the font file
bold
object (FontVariant)
FontVariant
name
string
The name of the font variant
file
string
The URL of the font file
family
string
The font family
config
object (Config)
Config
current
string
The current configuration
list
array of object (ThemeConfiguration)
A list of configurations
Array of ThemeConfiguration
name
string
The name of the configuration
global_config
object
Global configuration key-value pairs for this theme config.
page
array of object (ThemeConfigListPage)
An array of pages
Array of ThemeConfigListPage
page
string
Name of the page
settings
object (ThemeConfigListPageSettingsProps)
ThemeConfigListPageSettingsProps
props
object
Page settings key-value pairs.
global_schema
object (GlobalSchema)
GlobalSchema
props
array of object
List of global property definitions.
preset
object
An Object of default theme configurations
applied
boolean
Whether the theme has been applied or not
is_private
boolean
Whether the theme is private or not
tags
array of string
An array of tags associated with the theme
_id
string
The unique identifier of the theme
application_id
string
The ID of the application
marketplace_theme_id
string
The ID of the theme in the marketplace
meta
object (ThemeMeta)
ThemeMeta
payment
object (ThemePayment)
ThemePayment
is_paid
boolean
Whether the theme is a paid theme.
amount
number
The amount to be paid for the theme.
description
string
The description of the theme
industry
array of string
An array of industries associated with the theme
release
object (Release)
Release
notes
string
The release notes of the theme
version
string
The version of the theme
images
object (Images)
Images
desktop
string
The URL of the desktop image
mobile
string
The URL of the mobile image
slug
string
The slug of the theme
name
string
The name of the theme
name
string
The name of the theme
template_theme_id
string
The ID of the template theme
version
string
The version of the theme
styles
object
The styles associated with the theme
created_at
string
| date-time
The creation timestamp of the theme
updated_at
string
| date-time
The last update timestamp of the theme
global_sections
array of object
Global sections associated with the theme
assets
object (Assets)
Assets
umd_js
object (UMDJs)
UMDJs
link
string
Single UMD JS asset URL.
links
array of string
List of UMD JS asset URLs.
common_js
object (CommonJS)
CommonJS
link
string
CommonJS asset URL.
css
object (CSS)
CSS
link
string
Single CSS asset URL.
links
array of string
List of CSS asset URLs.
available_sections
array of object (SectionItem)
Available sections information
Array of SectionItem
props
array of object
Section property definitions.
blocks
array of object
Blocks
name
string
Name of the section
preset
object (SectionPreset)
SectionPreset
blocks
array of object (Block)
List of blocks in this preset.
Array of Block
type
string
The type of the block.
name
string
The name of the block.
props
object (BlockProps)
BlockProps
image
object (ImagePickerProp)
ImagePickerProp
type
string
The type of the property.
value
string
The value of the image picker property.
slide_link
object (UrlProp)
UrlProp
type
string
The type of the property.
value
string
The value of the URL property.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
label
string
Label for the section
theme_type
string
Type of the Theme
Enum
company_id
number
The company id in which sales channel exists
src
string
URL of the theme source or archive.
applied_themes
array of object
Applied themes array
Examples
Parameters
company_id:
19243
application_id:
"000000000000000000000001"
Was this section helpful?
GET
Response
Get applied theme
getAppliedTheme
FDK Method Name: getLatestVersionOfThemeBySlug
Retrieve the most recent version of a theme using its slug.
Parameters
application_id
string
Required
The ID of the application
company_id
integer
Required
The ID of the company
slug_name
string
Required
Slug of theme
Response
200
Successful operation
Array of MarketplaceTheme
_id
string
Theme ID
payment
object (PaymentInfo)
PaymentInfo
is_paid
boolean
Indicates if the theme is paid
amount
number
Amount of payment
contact
object (ContactInfo)
ContactInfo
developer_contact
array of string
Developer contact information
seller_contact
string
Seller contact information
industry
array of string
Industries the theme is suitable for
is_update
boolean
Indicates if the theme is an update
is_default
boolean
Indicates if the theme is a default theme
name
string
Theme name
tagline
string
Theme tagline
description
string
Theme description
catalog_size
object (CatalogSize)
CatalogSize
min
integer
Minimum catalog size
max
integer
Maximum catalog size
images
object (MarketplaceThemeImages)
MarketplaceThemeImages
desktop
string
Desktop theme image URL
mobile
string
Mobile theme image URL
carousel
array of object (CarouselItem)
Carousel items
Array of CarouselItem
desktop
string
Desktop carousel image URL
mobile
string
Mobile carousel image URL
src
string
Theme source URL
explore
object (ExploreInfo)
ExploreInfo
title
string
Explore feature title
description
string
Explore feature description
features
array of object (Feature)
Features
Array of Feature
category
string
Feature category
list
array of object (FeatureItem)
Features
Array of FeatureItem
label
string
Feature properties
description
string
Feature description
highlights
array of object (Highlight)
Highlights
Array of Highlight
title
string
Highlight title
description
string
Highlight description
image
string
Highlight image URL
variations
array of object (Variation)
Variations
Array of Variation
name
string
Variation name
color
string
Variation color
demo_url
string
Variation demo URL
images
object (MarketplaceThemeImages)
MarketplaceThemeImages
desktop
string
Desktop theme image URL
mobile
string
Mobile theme image URL
documentation
object (Documentation)
Documentation
notes
string
Documentation notes
url
string
Documentation URL
status
string
Theme status
step
integer
Theme step
comments
object (Comments)
Comments
developer_remark
string
Developer remark
reviewer_feedback
string
Reviewer feedback
release
object (Release)
Release
notes
string
The release notes of the theme
version
string
The version of the theme
slug
string
Theme slug
organization_id
string
Organization ID
user_id
string
User ID
created_at
string
| date-time
Theme creation timestamp
updated_at
string
| date-time
Theme update timestamp
template_theme_id
string
Template theme ID
theme_type
string
Theme type
Examples
Parameters
application_id:
"000000000000000000000001"
company_id:
123
slug_name:
"astra"
Was this section helpful?
GET
Response
Get latest version of theme by slug.
getLatestVersionOfThemeBySlug
FDK Method Name: createGlobalSection
Creates a new global section for a given theme. The section can be created with status 'draft' or 'pending_for_approval'.
The API will automatically match the section name with available sections from the template theme and populate default_sections if a match is found.
Parameters
company_id
integer
Required
Company ID
application_id
string
Required
Application ID
theme_id
string
Required
Theme ID
socket_id
string
Required
Socket ID
Request body
section
object (GlobalSectionSectionUpdate)
Required
GlobalSectionSectionUpdate
_id
string
ID of the section
name
string
Name of the section
label
string
Display label for the section
props
object (SectionProps)
SectionProps
title
object (TextProp)
TextProp
value
string
The value of the text property.
type
string
The type of the property.
item_margin
object (TextProp)
TextProp
value
string
The value of the text property.
type
string
The type of the property.
autoplay
object (CheckboxProp)
CheckboxProp
value
boolean
The value of the checkbox property.
type
string
The type of the property.
slide_interval
object (RangeProp)
RangeProp
value
integer
The value of the range property.
type
string
The type of the property.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
blocks
array of object
Array of blocks within the section
__source
object (SourceMeta)
SourceMeta
type
string
Source type
Default Value : themeBundle
Enum
id
string
Identifier of the source entity
bundle_name
string
Human-readable bundle name if applicable
global_reference
string
Reference to the global section ID
Pattern : ^[0-9a-fA-F]{24}$
preset
object
Preset configuration for the section
predicate
object (SectionPredicate)
SectionPredicate
screen
object (SectionScreenPredicate)
SectionScreenPredicate
mobile
boolean
Whether to enable on mobile screens.
desktop
boolean
Whether to enable on desktop screens.
tablet
boolean
Whether to enable on tablet screens.
user
object (SectionUserPredicate)
SectionUserPredicate
user_type
string
High-level audience bucket (e.g., "all_user").
Enum
user_groups
object (SectionUserGroups)
SectionUserGroups
l1
object (UserGroupInEx)
UserGroupInEx
includes
array of string
Group identifiers explicitly included.
excludes
array of string
Group identifiers explicitly excluded.
l2
object (UserGroupInEx)
UserGroupInEx
includes
array of string
Group identifiers explicitly included.
excludes
array of string
Group identifiers explicitly excluded.
user_login_status
object (UserGroupsUserLoginStatusPredicate)
UserGroupsUserLoginStatusPredicate
selected
boolean
Whether to combine the user groups filter with the login status filter.
login_status
boolean
Whether the predicate targets logged-in users (true) or logged-out users (false).
user_status
object (UserStatusPredicate)
UserStatusPredicate
new_user
boolean
Whether to enable on new users.
existing_user
boolean
Whether to enable on existing users
route
object (SectionRoutePredicate)
SectionRoutePredicate
selected
string
Route selection mode (e.g., "none" to disable route constraint).
exact_url
string
Exact URL to match when `selected` is configured accordingly.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
platform
object (SectionPlatformPredicate)
SectionPlatformPredicate
ios
boolean
Whether to enable on iOS app.
android
boolean
Whether to enable on Android app.
web
boolean
Whether to enable on Web.
theme_zones
object (ThemeZones)
ThemeZones
type
string
Zone type (implementation-defined, e.g., "state", "zone_list", etc.).
zones
object (IncludeExcludeStateCityZone)
IncludeExcludeStateCityZone
include
array of string
State/city identifiers explicitly included.
exclude
array of string
State/city identifiers explicitly excluded.
states
object (IncludeExcludeStateCityZone)
IncludeExcludeStateCityZone
include
array of string
State/city identifiers explicitly included.
exclude
array of string
State/city identifiers explicitly excluded.
cities
object (IncludeExcludeStateCityZone)
IncludeExcludeStateCityZone
include
array of string
State/city identifiers explicitly included.
exclude
array of string
State/city identifiers explicitly excluded.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
experimental_features
array of string
Optional list of experimental features.
schedule
array of object
Optional list of scheduling rules; empty array means always active.
user_status
object (UserStatusPredicate)
UserStatusPredicate
new_user
boolean
Whether to enable on new users.
existing_user
boolean
Whether to enable on existing users
status
string
Required
Status of the section
Enum
comment
string
Optional comment for the section
updated_by
string
ID of the user who last updated the section
updated_at
string
| date-time
Timestamp of last update
created_at
string
| date-time
Timestamp of creations
is_deleted
boolean
Soft delete flag
Default Value : false
Response
200
Global section created successfully
GlobalSection
_id
string
Unique identifier of the global section
application_id
string
ID of the application this section belongs to
theme_id
string
ID of the theme this section belongs to
section
object (GlobalSectionSectionUpdate)
GlobalSectionSectionUpdate
_id
string
ID of the section
name
string
Name of the section
label
string
Display label for the section
props
object (SectionProps)
SectionProps
title
object (TextProp)
TextProp
value
string
The value of the text property.
type
string
The type of the property.
item_margin
object (TextProp)
TextProp
value
string
The value of the text property.
type
string
The type of the property.
autoplay
object (CheckboxProp)
CheckboxProp
value
boolean
The value of the checkbox property.
type
string
The type of the property.
slide_interval
object (RangeProp)
RangeProp
value
integer
The value of the range property.
type
string
The type of the property.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
blocks
array of object
Array of blocks within the section
__source
object (SourceMeta)
SourceMeta
type
string
Source type
Default Value : themeBundle
Enum
id
string
Identifier of the source entity
bundle_name
string
Human-readable bundle name if applicable
global_reference
string
Reference to the global section ID
Pattern : ^[0-9a-fA-F]{24}$
preset
object
Preset configuration for the section
predicate
object (SectionPredicate)
SectionPredicate
screen
object (SectionScreenPredicate)
SectionScreenPredicate
mobile
boolean
Whether to enable on mobile screens.
desktop
boolean
Whether to enable on desktop screens.
tablet
boolean
Whether to enable on tablet screens.
user
object (SectionUserPredicate)
SectionUserPredicate
user_type
string
High-level audience bucket (e.g., "all_user").
Enum
user_groups
object (SectionUserGroups)
SectionUserGroups
l1
object (UserGroupInEx)
UserGroupInEx
includes
array of string
Group identifiers explicitly included.
excludes
array of string
Group identifiers explicitly excluded.
l2
object (UserGroupInEx)
UserGroupInEx
includes
array of string
Group identifiers explicitly included.
excludes
array of string
Group identifiers explicitly excluded.
user_login_status
object (UserGroupsUserLoginStatusPredicate)
UserGroupsUserLoginStatusPredicate
selected
boolean
Whether to combine the user groups filter with the login status filter.
login_status
boolean
Whether the predicate targets logged-in users (true) or logged-out users (false).
user_status
object (UserStatusPredicate)
UserStatusPredicate
new_user
boolean
Whether to enable on new users.
existing_user
boolean
Whether to enable on existing users
route
object (SectionRoutePredicate)
SectionRoutePredicate
selected
string
Route selection mode (e.g., "none" to disable route constraint).
exact_url
string
Exact URL to match when `selected` is configured accordingly.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
platform
object (SectionPlatformPredicate)
SectionPlatformPredicate
ios
boolean
Whether to enable on iOS app.
android
boolean
Whether to enable on Android app.
web
boolean
Whether to enable on Web.
theme_zones
object (ThemeZones)
ThemeZones
type
string
Zone type (implementation-defined, e.g., "state", "zone_list", etc.).
zones
object (IncludeExcludeStateCityZone)
IncludeExcludeStateCityZone
include
array of string
State/city identifiers explicitly included.
exclude
array of string
State/city identifiers explicitly excluded.
states
object (IncludeExcludeStateCityZone)
IncludeExcludeStateCityZone
include
array of string
State/city identifiers explicitly included.
exclude
array of string
State/city identifiers explicitly excluded.
cities
object (IncludeExcludeStateCityZone)
IncludeExcludeStateCityZone
include
array of string
State/city identifiers explicitly included.
exclude
array of string
State/city identifiers explicitly excluded.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
experimental_features
array of string
Optional list of experimental features.
schedule
array of object
Optional list of scheduling rules; empty array means always active.
user_status
object (UserStatusPredicate)
UserStatusPredicate
new_user
boolean
Whether to enable on new users.
existing_user
boolean
Whether to enable on existing users
status
string
Status of the section
Enum
comment
string
Optional comment for the section
updated_by
string
ID of the user who last updated the section
updated_at
string
| date-time
Timestamp of last update
created_at
string
| date-time
Timestamp of creations
is_deleted
boolean
Soft delete flag
Default Value : false
default_sections
object
Default section configuration and schema
created_at
string
| date-time
Timestamp when the section was created
updated_at
string
| date-time
Timestamp when the section was last updated
lock
object (GlobalSectionLock)
Nullable
GlobalSectionLock
user
object (GlobalSectionLockUser)
GlobalSectionLockUser
id
string
ID of the user holding the lock
name
string
Name of the user holding the lock
locked_at
string
| date-time
When the lock was acquired
last_activity
string
| date-time
When the lock will expire
theme_id
string
Theme id for context
socket_id
string
Socket id for context
global_section_id
string
Global section id for context
Examples
Parameters
company_id:
1
application_id:
"000000000000000000000001"
theme_id:
"000000000000000000000001"
socket_id:
"test-socket-create-123"
body:
body
Was this section helpful?
POST
Response
Create a new global section
createGlobalSection
FDK Method Name: updateGlobalSectionById
Updates a global section's configuration and content with atomic lock management. This endpoint automatically acquires a lock before updating and releases it afterward, ensuring safe concurrent editing. Supports status transitions from draft to pending_for_approval.
Parameters
company_id
integer
Required
ID of the company that owns the application.
application_id
string
Required
ID of the application that contains the theme.
theme_id
string
Required
ID of the theme the section belongs to.
global_section_id
string
Required
ID of the global section to update.
socket_id
string
Required
Socket ID
Request body
section
object (GlobalSectionSectionUpdate)
Required
GlobalSectionSectionUpdate
_id
string
ID of the section
name
string
Name of the section
label
string
Display label for the section
props
object (SectionProps)
SectionProps
title
object (TextProp)
TextProp
value
string
The value of the text property.
type
string
The type of the property.
item_margin
object (TextProp)
TextProp
value
string
The value of the text property.
type
string
The type of the property.
autoplay
object (CheckboxProp)
CheckboxProp
value
boolean
The value of the checkbox property.
type
string
The type of the property.
slide_interval
object (RangeProp)
RangeProp
value
integer
The value of the range property.
type
string
The type of the property.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
blocks
array of object
Array of blocks within the section
__source
object (SourceMeta)
SourceMeta
type
string
Source type
Default Value : themeBundle
Enum
id
string
Identifier of the source entity
bundle_name
string
Human-readable bundle name if applicable
global_reference
string
Reference to the global section ID
Pattern : ^[0-9a-fA-F]{24}$
preset
object
Preset configuration for the section
predicate
object (SectionPredicate)
SectionPredicate
screen
object (SectionScreenPredicate)
SectionScreenPredicate
mobile
boolean
Whether to enable on mobile screens.
desktop
boolean
Whether to enable on desktop screens.
tablet
boolean
Whether to enable on tablet screens.
user
object (SectionUserPredicate)
SectionUserPredicate
user_type
string
High-level audience bucket (e.g., "all_user").
Enum
user_groups
object (SectionUserGroups)
SectionUserGroups
l1
object (UserGroupInEx)
UserGroupInEx
includes
array of string
Group identifiers explicitly included.
excludes
array of string
Group identifiers explicitly excluded.
l2
object (UserGroupInEx)
UserGroupInEx
includes
array of string
Group identifiers explicitly included.
excludes
array of string
Group identifiers explicitly excluded.
user_login_status
object (UserGroupsUserLoginStatusPredicate)
UserGroupsUserLoginStatusPredicate
selected
boolean
Whether to combine the user groups filter with the login status filter.
login_status
boolean
Whether the predicate targets logged-in users (true) or logged-out users (false).
user_status
object (UserStatusPredicate)
UserStatusPredicate
new_user
boolean
Whether to enable on new users.
existing_user
boolean
Whether to enable on existing users
route
object (SectionRoutePredicate)
SectionRoutePredicate
selected
string
Route selection mode (e.g., "none" to disable route constraint).
exact_url
string
Exact URL to match when `selected` is configured accordingly.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
platform
object (SectionPlatformPredicate)
SectionPlatformPredicate
ios
boolean
Whether to enable on iOS app.
android
boolean
Whether to enable on Android app.
web
boolean
Whether to enable on Web.
theme_zones
object (ThemeZones)
ThemeZones
type
string
Zone type (implementation-defined, e.g., "state", "zone_list", etc.).
zones
object (IncludeExcludeStateCityZone)
IncludeExcludeStateCityZone
include
array of string
State/city identifiers explicitly included.
exclude
array of string
State/city identifiers explicitly excluded.
states
object (IncludeExcludeStateCityZone)
IncludeExcludeStateCityZone
include
array of string
State/city identifiers explicitly included.
exclude
array of string
State/city identifiers explicitly excluded.
cities
object (IncludeExcludeStateCityZone)
IncludeExcludeStateCityZone
include
array of string
State/city identifiers explicitly included.
exclude
array of string
State/city identifiers explicitly excluded.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
experimental_features
array of string
Optional list of experimental features.
schedule
array of object
Optional list of scheduling rules; empty array means always active.
user_status
object (UserStatusPredicate)
UserStatusPredicate
new_user
boolean
Whether to enable on new users.
existing_user
boolean
Whether to enable on existing users
status
string
Required
Status of the section
Enum
comment
string
Optional comment for the section
updated_by
string
ID of the user who last updated the section
updated_at
string
| date-time
Timestamp of last update
created_at
string
| date-time
Timestamp of creations
is_deleted
boolean
Soft delete flag
Default Value : false
Response
200
Global section updated successfully
GlobalSection
_id
string
Unique identifier of the global section
application_id
string
ID of the application this section belongs to
theme_id
string
ID of the theme this section belongs to
section
object (GlobalSectionSectionUpdate)
GlobalSectionSectionUpdate
_id
string
ID of the section
name
string
Name of the section
label
string
Display label for the section
props
object (SectionProps)
SectionProps
title
object (TextProp)
TextProp
value
string
The value of the text property.
type
string
The type of the property.
item_margin
object (TextProp)
TextProp
value
string
The value of the text property.
type
string
The type of the property.
autoplay
object (CheckboxProp)
CheckboxProp
value
boolean
The value of the checkbox property.
type
string
The type of the property.
slide_interval
object (RangeProp)
RangeProp
value
integer
The value of the range property.
type
string
The type of the property.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
blocks
array of object
Array of blocks within the section
__source
object (SourceMeta)
SourceMeta
type
string
Source type
Default Value : themeBundle
Enum
id
string
Identifier of the source entity
bundle_name
string
Human-readable bundle name if applicable
global_reference
string
Reference to the global section ID
Pattern : ^[0-9a-fA-F]{24}$
preset
object
Preset configuration for the section
predicate
object (SectionPredicate)
SectionPredicate
screen
object (SectionScreenPredicate)
SectionScreenPredicate
mobile
boolean
Whether to enable on mobile screens.
desktop
boolean
Whether to enable on desktop screens.
tablet
boolean
Whether to enable on tablet screens.
user
object (SectionUserPredicate)
SectionUserPredicate
user_type
string
High-level audience bucket (e.g., "all_user").
Enum
user_groups
object (SectionUserGroups)
SectionUserGroups
l1
object (UserGroupInEx)
UserGroupInEx
includes
array of string
Group identifiers explicitly included.
excludes
array of string
Group identifiers explicitly excluded.
l2
object (UserGroupInEx)
UserGroupInEx
includes
array of string
Group identifiers explicitly included.
excludes
array of string
Group identifiers explicitly excluded.
user_login_status
object (UserGroupsUserLoginStatusPredicate)
UserGroupsUserLoginStatusPredicate
selected
boolean
Whether to combine the user groups filter with the login status filter.
login_status
boolean
Whether the predicate targets logged-in users (true) or logged-out users (false).
user_status
object (UserStatusPredicate)
UserStatusPredicate
new_user
boolean
Whether to enable on new users.
existing_user
boolean
Whether to enable on existing users
route
object (SectionRoutePredicate)
SectionRoutePredicate
selected
string
Route selection mode (e.g., "none" to disable route constraint).
exact_url
string
Exact URL to match when `selected` is configured accordingly.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
platform
object (SectionPlatformPredicate)
SectionPlatformPredicate
ios
boolean
Whether to enable on iOS app.
android
boolean
Whether to enable on Android app.
web
boolean
Whether to enable on Web.
theme_zones
object (ThemeZones)
ThemeZones
type
string
Zone type (implementation-defined, e.g., "state", "zone_list", etc.).
zones
object (IncludeExcludeStateCityZone)
IncludeExcludeStateCityZone
include
array of string
State/city identifiers explicitly included.
exclude
array of string
State/city identifiers explicitly excluded.
states
object (IncludeExcludeStateCityZone)
IncludeExcludeStateCityZone
include
array of string
State/city identifiers explicitly included.
exclude
array of string
State/city identifiers explicitly excluded.
cities
object (IncludeExcludeStateCityZone)
IncludeExcludeStateCityZone
include
array of string
State/city identifiers explicitly included.
exclude
array of string
State/city identifiers explicitly excluded.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
experimental_features
array of string
Optional list of experimental features.
schedule
array of object
Optional list of scheduling rules; empty array means always active.
user_status
object (UserStatusPredicate)
UserStatusPredicate
new_user
boolean
Whether to enable on new users.
existing_user
boolean
Whether to enable on existing users
status
string
Status of the section
Enum
comment
string
Optional comment for the section
updated_by
string
ID of the user who last updated the section
updated_at
string
| date-time
Timestamp of last update
created_at
string
| date-time
Timestamp of creations
is_deleted
boolean
Soft delete flag
Default Value : false
default_sections
object
Default section configuration and schema
created_at
string
| date-time
Timestamp when the section was created
updated_at
string
| date-time
Timestamp when the section was last updated
lock
object (GlobalSectionLock)
Nullable
GlobalSectionLock
user
object (GlobalSectionLockUser)
GlobalSectionLockUser
id
string
ID of the user holding the lock
name
string
Name of the user holding the lock
locked_at
string
| date-time
When the lock was acquired
last_activity
string
| date-time
When the lock will expire
theme_id
string
Theme id for context
socket_id
string
Socket id for context
global_section_id
string
Global section id for context
Examples
Parameters
company_id:
1
application_id:
"000000000000000000000001"
theme_id:
"000000000000000000000001"
global_section_id:
"647abc789abc123456789013"
socket_id:
"test-socket-update-456"
body:
body
Was this section helpful?
PUT
Response
Update global section by ID
updateGlobalSectionById
FDK Method Name: bulkCreateSections
Create multiple sections for a theme in a single request. This endpoint allows you to create multiple sections at once for a specific theme and optionally associate them with a page. Each section will be created with the provided configuration and added to the theme's available sections.
Parameters
company_id
integer
Required
The ID of the company that owns the application.
application_id
string
Required
The ID of the application that contains the theme.
theme_id
string
Required
The ID of the theme to create sections for.
socket_id
string
Required
Socket ID for real-time updates.
Request body
sections
array of object (SectionCreateInputSchema)
Required
Array of section objects to create
Minimum Items : 1
Array of SectionCreateInputSchema
name
string
The name of the section
label
string
The display label of the section
props
array of object
Section properties configuration
blocks
array of object
Section blocks configuration
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
page_id
string
Optional page ID to associate the sections with
Response
200
Successfully created sections
BulkCreateSections
multiple_users
boolean
Indicates if multiple users are actively editing this page
success
boolean
Indicates if the operation was successful
created_count
integer
Number of sections created
sections
array of object (SectionCreatedSchema)
Array of created section objects with current version
Array of SectionCreatedSchema
_id
string
The unique identifier of the created section
name
string
The name of the section
label
string
The display label of the section
theme_id
string
The ID of the theme this section belongs to
application_id
string
The ID of the application
props
array of object
Section properties
blocks
array of object
Section blocks
created_at
string
| date-time
Creation timestamp
updated_at
string
| date-time
Last update timestamp
current_version
string
Current version identifier of the section
live_version
string
Nullable
Live version identifier of the section
section_version_id
string
The unique identifier of the section version
__source
object
Source information for the section
predicate
object
Predicate conditions for the section
status
string
Approval status of the section
comment
string
Comment associated with the section
updated_by
string
User ID of who last updated the section
is_deleted
boolean
Indicates if the section is deleted
Examples
Parameters
company_id:
123
application_id:
"000000000000000000000001"
theme_id:
"000000000000000000000001"
socket_id:
"socket123"
body:
body
Was this section helpful?
POST
Response
Bulk create sections
bulkCreateSections
FDK Method Name: bulkUpdateSections
Update multiple sections for a theme in a single request. This endpoint allows you to update multiple sections at once for a specific theme. You can modify section configurations, update properties, or delete sections by passing the appropriate data. Each section must include its ID and the updated section payload.
Parameters
company_id
integer
Required
The ID of the company that owns the application.
application_id
string
Required
The ID of the application that contains the theme.
theme_id
string
Required
The ID of the theme to update sections for.
socket_id
string
Required
Socket ID for real-time updates.
Request body
sections
array of object (SectionUpdateInputSchema)
Required
Array of section update objects
Minimum Items : 1
Array of SectionUpdateInputSchema
_id
string
Required
The ID of the section to update
section
object (SectionUpdatePayloadSchema)
Required
SectionUpdatePayloadSchema
name
string
The name of the section
label
string
The display label of the section
props
array of object
Section properties configuration
blocks
array of object
Section blocks configuration
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
page_id
string
Optional page ID to associate the sections with
Response
200
Successfully updated sections
BulkUpdateSections
multiple_users
boolean
Indicates if multiple users are actively editing this page
success
boolean
Indicates if the operation was successful
updated_count
integer
Number of sections updated
sections
array of object (SectionUpdatedSchema)
Array of updated section objects with current version
Array of SectionUpdatedSchema
_id
string
The unique identifier of the updated section
name
string
The name of the section
label
string
The display label of the section
theme_id
string
The ID of the theme this section belongs to
application_id
string
The ID of the application
props
array of object
Section properties
blocks
array of object
Section blocks
created_at
string
| date-time
Creation timestamp
updated_at
string
| date-time
Last update timestamp
current_version
string
Current version identifier of the section
live_version
string
Nullable
Live version identifier of the section
section_version_id
string
The unique identifier of the section version
__source
object
Source information for the section
predicate
object
Predicate conditions for the section
status
string
Approval status of the section
comment
string
Comment associated with the section
updated_by
string
User ID of who last updated the section
is_deleted
boolean
Indicates if the section is deleted
deleted_count
integer
Number of sections deleted (optional, only present if sections were deleted)
deleted_sections
array of object (DeletedSectionItemSchema)
Array of deleted section IDs (optional, only present if sections were deleted)
Array of DeletedSectionItemSchema
_id
string
The ID of the deleted section
Examples
Parameters
company_id:
123
application_id:
"000000000000000000000001"
theme_id:
"000000000000000000000001"
socket_id:
"socket123"
body:
body
Was this section helpful?
PUT
Response
Bulk update sections
bulkUpdateSections
Operations
POST
# Create a Page Mapping
PUT
# Update a Page Mapping
DEL
# Delete a Page Mapping
Parameters
company_id
integer
Required
Company ID
application_id
string
Required
Application ID
theme_id
string
Required
Theme ID
Request body
fallback
string
Nullable
Fallback page when no mapping matches.
page
string
Page identifier to map.
slug
string
Slug for the mapped page.
filter
object (PageMapperFilterConfiguration)
PageMapperFilterConfiguration
platform
object (PageMapperPlatformFilter)
PageMapperPlatformFilter
ios
boolean
Whether the mapping applies on iOS.
android
boolean
Whether the mapping applies on Android.
web
boolean
Whether the mapping applies on web.
user
object (PageMapperUserFilter)
PageMapperUserFilter
user_type
string
User type (user_group, all_user, registered, guest).
Enum
schedule
object (PageMapperScheduleFilter)
PageMapperScheduleFilter
start
string
| date-time
Start of the schedule window.
end
string
| date-time
End of the schedule window.
feature_store
string
Nullable
Featured store where page is supposed to be mapped
Response
200
400
Success
PageMapperResponseSchema
message
string
Message indicating the result of the page mapping operation
Examples
Parameters
company_id:
882
application_id:
"6640f9f1e5e7a7a654e2a8d2"
theme_id:
"6640f9f1e5e7a7a654e2a8d1"
body:
body
Was this section helpful?
POST
Response
Create a Page Mapping
createPageMapping
Parameters
company_id
integer
Required
Company ID
application_id
string
Required
Application ID
theme_id
string
Required
Theme ID
page_value
string
Required
Value of Page
Request body
fallback
string
Nullable
Fallback page when no mapping matches.
predicate_id
string
Predicate ID for the page mapping
slug
string
Slug for the mapped page.
filter
object (PageMapperFilterConfiguration)
PageMapperFilterConfiguration
platform
object (PageMapperPlatformFilter)
PageMapperPlatformFilter
ios
boolean
Whether the mapping applies on iOS.
android
boolean
Whether the mapping applies on Android.
web
boolean
Whether the mapping applies on web.
user
object (PageMapperUserFilter)
PageMapperUserFilter
user_type
string
User type (user_group, all_user, registered, guest).
Enum
schedule
object (PageMapperScheduleFilter)
PageMapperScheduleFilter
start
string
| date-time
Start of the schedule window.
end
string
| date-time
End of the schedule window.
feature_store
string
Nullable
Featured store where page is supposed to be mapped
Response
200
400
Success
PageMapperResponseSchema
message
string
Message indicating the result of the page mapping operation
Examples
Parameters
company_id:
882
application_id:
"6640f9f1e5e7a7a654e2a8d2"
theme_id:
"6640f9f1e5e7a7a654e2a8d1"
page_value:
"to-modify-page-for-page-mapping"
body:
body
Was this section helpful?
PUT
Response
Update a Page Mapping
updatePageMapping
Parameters
company_id
integer
Required
Company ID
application_id
string
Required
Application ID
theme_id
string
Required
Theme ID
page_value
string
Required
Value of Page
predicate_id
string
Required
_id of page mappings
Response
200
400
Success
PageMapperResponseSchema
message
string
Message indicating the result of the page mapping operation
Examples
Parameters
company_id:
882
application_id:
"6640f9f1e5e7a7a654e2a8d2"
theme_id:
"6640f9f1e5e7a7a654e2a8d1"
page_value:
"to-delete-page-for-page-mapping"
predicate_id:
"6640f9f1e5e7a7a654e2a8d6"
Was this section helpful?
DEL
Response