- Overview
- Reference
- API Structure
- Public API
- Introduction
- Loyalty Club
- Member
- Offers
- Rewards
- Games
- CMS Content
- Management API
- Introduction
- Core
- Applications
- Privacy Policy
- Cookie Policy
- Terms
- Domains
- Domain Email Configs
- Domain Web Configs
- TLS Certificates
- Links
- Fonts
- Subunits
- Subunits Scopes
- SMS Sender Identities
- Contacts
- Translations
- Promotions Policy
- Tracker
- Social Logins
- Billing
- Members
- Listing Members
- Member Profile
- Imports
- Groups
- Programs
- Benefits
- Cars
- Webhooks
- Misc
- Receipts
- Stores
- Offers
- Rewards
- Triggerer
- CMS
- Introduction
- Pages
- Components
- Website
- Website Domains
- Venue Info
- Landing Pages
- Landing Page Templates
- Articles
- Events
- Events Groups
- Job Postings
- Press Releases
- Tags
- Service Messages
- Content Prototypes
- ContentPrototype Model
- List Content Prototypes
- Show Content Prototype
- Create Content Prototype
- Update Content Prototype
- Destroy Content Prototype
- List Organization Content Prototypes
- Show Organization Content Prototype
- Create Organization Content Prototype
- Update Organization Content Prototype
- Destroy Organization Content Prototype
- Mixed Content
- Attachments
- Events
- Games
- Scraper
- Files
- Receipts
- Users API
- Operations API
- Introduction
- Manager API
- Tenant API
- Messaging API
- Data API
- ML API
- Introduction
- Predict Sending KPI v1
- Explain Sending KPI Prediction v1
- Predict Sending KPI In Date Range v1
- Predict Sending Popularity v2
- Predict Sending Text Popularity v2
- Predict Sending Time Series Popularity v2
- Explain Sending Popularity Prediction v2
- Explain Sending Text Popularity Prediction v2
- Explain Sending Time Series Popularity Prediction v2
- Recommend sending time v2
- Generate Image
- Generate Text
- Generate Sending Text
- (Draft) Reporting API
- Other
Page Model
Page model#
Example#
{
"page": {
"id": 22,
"customer_ids": [447],
"locales": ["en", "pl"],
"products": ["default"],
"status": "published",
"visible_since": "2022-04-05T10:01:38.071142Z",
"visible_until": "2022-04-19T10:01:38.071208Z",
"sorting_priority": 1,
"service": "store_page",
"url": "/stores/{id}-{slug}",
"title": { "en": "Title", "pl": "Tytuł" },
"slug": { "en": "title", "pl": "tytul" },
"created_at": "2022-04-12T10:01:38.071466Z",
"updated_at": "2022-04-12T14:50:59.475870Z",
"archived_at": null,
"publication_status": "published",
"components": [
{
"type": "html_block",
"title": { "en": "Hi there!", "pl": "Cześć!" },
"body": { "en": "<p>What's up?</p>", "pl": "<p>Jak leci?</p>" }
},
{
"type": "carousel",
"title": { "en": "Carousel", "pl": "Karuzela" },
"slides": [
{
"layout": "full",
"title": {
"text": { "en": "Title", "pl": "Tytuł" }, "color": "#ffffff"
},
"subtitle": {
"text": { "en": "Subtitle", "pl": "Subtytuł" }, "color": "#000fff"
},
"link": {
"text": { "en": "Link", "pl": "Odnośnik" }, "url": "https://example.com/", "link_opens_new_tab": true
},
"image": { "url": "https://cdn-files.dev.placewise.com/files/J9xAojek7mlYY1oxcmlPaHpvTA" }
}
]
}
]
}
}
Definition#
Key | Type | Optional | Read-only | Description |
---|---|---|---|---|
id | integer | no | yes | |
customer_ids | integer[] | no | no | Customers the record is assigned to |
locales | ISO 639-1 alpha-2 code[] | yes | no | Locales the record is be available to in Locales |
products | string[] | yes | no | Products the content is available for in Products |
status | enum: ['draft', 'published', 'unpublished'] | no | no | When 'published', the record is available in CMS Public API |
visible_since | datetime | yes | no | Date since the record is visible in CMS Public API |
visible_until | datetime | yes | no | Date until the record is visible in CMS Public API |
sorting_priority | integer | no | no | Priority of the record during sorting in CMS Public API |
service | string | yes | yes | See Service Pages |
url | string | no | no | See URL |
title | LocalizedContent | yes | no | |
created_at | datetime | no | yes | Time of record creation |
updated_at | datetime | no | yes | Time of record last update |
archived_at | datetime | no | yes | Time of record archivization |
publication_status | enum: ['published', 'draft', 'exipred', 'scheduled'] | no | yes | Visibility status of the record in CMS Public API |
components | object[] | yes | yes | List of components[^1] the Page is built of - see: ComponentsSchema |
URL#
url
attribute specifies address of Page within the Website - it is used toroute the URL to the Page.
(not tied to Service) Pages, this comes to just a plain string.
Service Pages#
service
attribute. Always single one exists for given service. They're preseeded by the system and are not destroyable.Component attached.
Modified at 2024-09-24 16:40:08