Content widget style object

A content widget style object (or simply "style object") contains CSS style information for a content widget. There is a basic user interface for editing style objects, but it is also possible to use the API directly.

A style object may have the following fields. If a field is not specified when the style object is created, its value will be null. If a field is not specified in an update, this field's value will not be changed. If a field is missing when read back from the server (in the response to a create, read or update), it means that its value is null.

Name	Type	Description
`id`	String	Identifier of the style object.
`siteGroupId`	String	Site group of this style object.
`description`	String	Short description of the style object.
`settings`	Object	Detailed settings for this style object, described below.
`lastUpdatedBy`	String	Email address of the last person to update the style object.
`lastUpdatedAt`	String (Date)	Time of the last update to the style object (ISO 8601 timestamp).
history	Array of Object	List of previous revisions.

Notes

If lastUpdatedBy and/or lastUpdatedAt is specified when the object is created, it has no effect. But if this is specified in an update, it has to match the current values for the update to succeed. This can be seen as a form of optimistic concurrency control. However, we cannot currently make any guarantees when there are several conflicting updates to the same object at the same time.
The history field is only included in the response when individual objects are read or updated. It contains up to 50 previous revisions, in reverse chronological order. These revisions are themselves style objects – except that they do not contain the fields id, siteGroupId and history. The history field is ignored when a style object is created or updated.

A style settings object may have the following fields. Observe that at this level, if a field is not specified in an update, it is treated as null. Hence, the field's value may be changed.

Name	Type	Required	Description
`type`	String	Yes	The style type. Currently always "basic".
`head`	String	No	Declarations that will be added to the head of the iframe rendering the widget.
`css`	String	Yes	The actual CSS style sheet. It can refer to classes and IDs in the template object .

Name

Type

Required

Description

type

String

Yes

The style type. Currently always "basic".

head

String

Declarations that will be added to the head of the iframe rendering the widget.

css

String

Yes

The actual CSS style sheet. It can refer to classes and IDs in the

template object

Last updated: December 28, 2023