Properties
| Name | Type | Description |
|---|---|---|
| name | string | User friendly name. |
| description | string | The user-friendly description. |
| widget_configuration | object | The JSON data that populates the template. |
| widget_template_uuid | string | The widget template UUID. |
| channel_id | integer | The ID of the channel on which to create this widget. Defaults to the first channel created on the store. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/widget_Post",
"title": "widget_Post",
"x-internal": false,
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "User friendly name."
},
"description": {
"type": "string",
"description": "The user-friendly description."
},
"widget_configuration": {
"type": "object",
"description": "The JSON data that populates the template.",
"format": "json"
},
"widget_template_uuid": {
"type": "string",
"description": "The widget template UUID."
},
"channel_id": {
"type": "integer",
"description": "The ID of the channel on which to create this widget. Defaults to the first channel created on the store."
}
},
"required": [
"name",
"widget_template_uuid"
]
}