Skip to main content

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​

StepEndpoint
1. Create the listPOST Enhanced content with the company ID
2. Optionally create sectionsPOST Section
3. Add content elementsPOST Content element
4. Link locations and publishPUT Enhanced content

Step 1 requires name, contentType and language. Content types are productsServices, menu, profile and events.

POST /enhancedContent/{companyId}
{
"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.

PUT /enhancedContent/{enhancedContentId}
{
"name": "Lunch menu",
"locationIds": [1001, 1002],
"language": { "key": 1, "value": "German" },
"published": true
}

Maintain content​

TaskEndpoint
List lists of a company or locationGET Enhanced content list with contextIds and contextType. Filter by contentType and status (live, not_connected)
Read a listGET Enhanced content
Read elementsGET Content elements
Edit an elementPUT Content element
Reorder elements in a sectionPUT Element order
Delete elementsDELETE Content elements with ids
Read sectionsGET Sections
Rename or reorder sectionsPUT Sections
Delete a listDELETE Enhanced content
caution

PUT Sections expects the full list of sections. Sections you leave out are deleted if they contain no elements.

info

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.