Enhanced Content Lists
An Enhanced Content List (ECL) holds structured content such as a menu, a product and service catalogue, events or profiles. A list belongs to a company, can be organized in sections, and is linked to one or more locations.
Create and publish a list
| Step | Endpoint |
|---|---|
| 1. Create the list | POST Enhanced content with the company ID |
| 2. Optionally create sections | POST Section |
| 3. Add content elements | POST Content element |
| 4. Link locations and publish | PUT Enhanced content |
Step 1 requires name, contentType and language. Content types are productsServices, menu, profile and events.
{
"name": "Lunch menu",
"contentType": "menu",
"language": { "key": 1, "value": "German" }
}
language is a key/value pair. Replace the example values with the language ID and name used in your workspace.
Step 3 requires name per element. Optional fields are description, price, images, url, youtubeUrl, idCode and the section.
Step 4 requires name, locationIds, language and published. A new list is not visible until published is true and locations are linked.
{
"name": "Lunch menu",
"locationIds": [1001, 1002],
"language": { "key": 1, "value": "German" },
"published": true
}
Maintain content
| Task | Endpoint |
|---|---|
| List lists of a company or location | GET Enhanced content list with contextIds and contextType. Filter by contentType and status (live, not_connected) |
| Read a list | GET Enhanced content |
| Read elements | GET Content elements |
| Edit an element | PUT Content element |
| Reorder elements in a section | PUT Element order |
| Delete elements | DELETE Content elements with ids |
| Read sections | GET Sections |
| Rename or reorder sections | PUT Sections |
| Delete a list | DELETE Enhanced content |
PUT Sections expects the full list of sections. Sections you leave out are deleted if they contain no elements.
DELETE Enhanced content also removes all links to locations.
Good to know
- Element names are limited to 100 characters, descriptions to 500 characters and prices to two decimals. Validate before bulk imports.
- Portals support different content. Google, for example, does not show menus and services in parallel. Check the portal requirements before you link a list.