> Portal Navigation: > > - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version. > - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages). > - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`). > - Top-level index of all portals: https://dev.wix.com/docs/llms.txt > - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt # UpdateEvent # Package: eventManagement # Namespace: EventManagement # Method link: https://dev.wix.com/docs/api-reference/business-solutions/events/event-management/events-v3/update-event.md ## Permission Scopes: Manage Events: SCOPE.DC-EVENTS.MANAGE-EVENTS ## Introduction Updates an event. --- ## REST API ### Schema ``` Method: updateEvent Description: Updates an event. URL: https://www.wixapis.com/events/v3/events/{event.id} Method: PATCH # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: event.id Method parameters: param name: event | type: Event | description: An Event is a structured record of a scheduled gathering, including its title, location, date and time, registration settings, status, and related URLs. You can use it to model and display event details, configure how guests register, and manage visibility and calendars across the site or app. - name: id | type: string | description: Event GUID. | required: true - name: location | type: Location | description: Event location. - name: name | type: string | description: Location name. This value is displayed instead of the address when the location is defined as TBD by setting the `locationTbd` property to `true`. - name: type | type: LocationType | description: Location type. - enum: - VENUE: Event is on-site at a specific physical location. - ONLINE: Event is online, such as a virtual video conference. - name: address | type: Address | description: Exact location address. - ONE-OF: - name: streetAddress | type: StreetAddress | description: Street address. - name: number | type: string | description: Street number. - name: name | type: string | description: Street name. - name: addressLine | type: string | description: Primary address information (street and building number). - name: country | type: string | description: 2-letter country code in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) format. - name: subdivision | type: string | description: Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). - name: city | type: string | description: City name. - name: postalCode | type: string | description: Zip or postal code. - name: addressLine2 | type: string | description: Secondary address information (suite or apartment number and room number). - name: locationTbd | type: boolean | description: Whether the event location is TBD. - name: dateAndTimeSettings | type: DateAndTimeSettings | description: Event date and time settings. - name: dateAndTimeTbd | type: boolean | description: Whether the event date and time are TBD. - name: dateAndTimeTbdMessage | type: string | description: Message that is displayed when time and date is TBD. **Note:** This field is only used when the `dateAndTimeTbd` field value is `true`. - name: startDate | type: string | description: Event start date. **Note:** This field is only returned when the `dateAndTimeTbd` field value is `false`. - name: endDate | type: string | description: Event end date. **Note:** This field is only returned when the `dateAndTimeTbd` field value is `false`. - name: timeZoneId | type: string | description: Event time zone GUID in the [TZ database](https://www.iana.org/time-zones) format. **Note:** This field is only returned when the `dateAndTimeTbd` field value is `false`. - name: hideEndDate | type: boolean | description: Whether the end date is hidden in the formatted date and time. - name: showTimeZone | type: boolean | description: Whether the time zone is displayed in the formatted schedule. - name: recurringEvents | type: Recurrences | description: Event repetitions. - name: individualEventDates | type: array | description: Individual event dates for recurring events. *Note:** Each date must be manually calculated and provided. There is no support for automatic generation using recurrence rules or patterns (for example, "Weekly"). When you create a recurring event: - Each occurrence is created as an independent event with its own unique GUID. - All occurrences in the series share the same `categoryId`, which allows you to identify all events in the recurring series. - To retrieve all events in a recurring series, query events by `recurringEvents.categoryId`. - Each event in the series can be independently updated or deleted using its individual event GUID. - name: startDate | type: string | description: Event start date. - name: endDate | type: string | description: Event end date. - name: timeZoneId | type: string | description: Event time zone GUID in the [TZ database](https://www.iana.org/time-zones) format. - name: showTimeZone | type: boolean | description: Whether the time zone is displayed in a formatted schedule. - name: formatted | type: Formatted | description: Formatted date and time settings. - name: title | type: string | description: Event title. - name: shortDescription | type: string | description: Short description that appears under the event title. **Note:** This field is returned only when the `DETAILS` fieldset is included in the request. - name: mainImage | type: Image | description: Main event image.
**Note:** This field is returned only when the `DETAILS` fieldset is included in the request. - name: id | type: string | description: WixMedia image GUID. - name: url | type: string | description: Image URL. - name: height | type: integer | description: Original image height. **Note:** You have to define height for the image to appear. - name: width | type: integer | description: Original image width. **Note:** You have to define width for the image to appear. - name: altText | type: string | description: Image alt text. - name: registration | type: Registration | description: RSVP or ticketing registration details.
**Note:** This field is returned only when the `REGISTRATION` fieldset is included in the request. - name: rsvp | type: RsvpRegistration | description: RSVP registration details. - name: responseType | type: ResponseType | description: Available answers for registration to an event. - enum: - YES_ONLY: Only a **Yes** answer is available to select when RSVP'ing to an event. - YES_AND_NO: *Yes** and **No** answers are available to select when RSVP'ing to an event. - name: limit | type: integer | description: How many guests can RSVP to an event. - name: waitlistEnabled | type: boolean | description: Whether a waitlist is opened when the total guest limit is reached. If `true`, guests can RSVP to an event and are automatically added to the waitlist with the `IN_WAITLIST` status. - name: startDate | type: string | description: Registration start date. - name: endDate | type: string | description: Registration end date. - name: tickets | type: TicketsRegistration | description: Ticket registration details. - name: guestsAssignedSeparately | type: boolean | description: Whether the registration form must be filled out separately for each ticket. - name: ticketLimitPerOrder | type: integer | description: Ticket limit per order.
Default: 20 tickets. - name: currency | type: string | description: Ticket price currency. - name: taxSettings | type: TaxSettings | description: How tax is applied. - name: type | type: TaxType | description: Tax application settings. - enum: - INCLUDED_IN_PRICE: Deduct the fee from the ticket price for a seller. For example, if you're selling tickets for $10, a ticket service fee of $0.25 is deducted from the price and you'll get $9.75. - ADDED_AT_CHECKOUT: Show the fee in addition to the ticket price at checkout and a guest pays the fee. For example, if you sell tickets for $10, a customer sees a ticket service fee of $0.25 and pays $10.25 in total. - name: name | type: string | description: Tax name. - name: rate | type: string | description: Tax rate. For example, `21.55`. - name: appliedToDonations | type: boolean | description: Apply tax to donations. - name: reservationDurationInMinutes | type: integer | description: Reservation duration in minutes. - name: external | type: ExternalRegistration | description: External registration details. - name: url | type: string | description: External event registration URL. - name: allowedGuestTypes | type: Type | description: Types of guests allowed to register. - enum: - VISITOR_OR_MEMBER: All site visitors can RSVP to the event. - MEMBER: Only people who have signed up as members of your site are able to RSVP to the event. - name: initialType | type: Type | description: Initial registration type which is set when creating an event. Once set, this value is immutable. To change the type of registration, use the `registration.type` field: - Events with `initialType` of `RSVP` or `TICKETING` can be changed to `EXTERNAL` or `NONE`. - `RSVP` events can't become `TICKETING` events, and vice versa. - enum: - RSVP: Guests register by RSVPing to the event. - TICKETING: Guests register by buying tickets. This property value never changes. - name: registrationPaused | type: boolean | description: Whether the registration is paused. - name: registrationDisabled | type: boolean | description: Whether the registration is disabled. - name: eventPageUrl | type: PageUrl | description: Event page URL components.
**Note:** This field is returned only when the `URLS` fieldset is included in the request. - name: base | type: string | description: The base URL. For premium sites, the base is the domain. For free sites, the base is the Wix site URL (for example, `https://mysite.wixsite.com/mysite`). - name: path | type: string | description: The path to the page. For example, `/product-page/a-product`. - name: form | type: Form | description: Event registration form.
**Note:** This field is returned only when the `FORM` fieldset is included in the request. - name: controls | type: array | description: Nested fields as an ordered list. - name: type | type: InputControlType | description: Field control type. - enum: - INPUT: Single text value field. - TEXTAREA: Single text value field with multiple lines. - DROPDOWN: Single-choice field with predefined values. - RADIO: Single-choice field with predefined values. - CHECKBOX: Multiple-choice field with predefined values. - NAME: Fields for entering first and last names. - GUEST_CONTROL: Fields for additional guests and their respective names. - ADDRESS_SHORT: Single-line address field. - ADDRESS_FULL: Full address field with multiple lines. - DATE: Fields for entering year, month, and day. - name: system | type: boolean | description: Whether the control is mandatory (such as `name` & `email`). When `true`, only the label can be changed. - name: inputs | type: array | description: Child inputs. - name: name | type: string | description: Field name. - name: label | type: string | description: Main field label. - name: additionalLabels | type: object | description: Additional labels for multi-valued fields such as address. - name: options | type: array | description: Predefined choice options for fields, such as dropdown. - name: mandatory | type: boolean | description: Whether field is mandatory. - name: maxLength | type: integer | description: Maximum number of accepted characters (relevant for text fields). - name: type | type: ValueType | description: Type which determines field format. Used to validate submitted response. - enum: TEXT, NUMBER, TEXT_ARRAY, DATE_TIME, ADDRESS - name: maxSize | type: integer | description: The maximum number of accepted values for array input. **Note:** Only applicable for `TEXT_ARRAY` input fields. - name: defaultOptionSelection | type: OptionSelection | description: Default option initially selected when an input has multiple choices. Defaults to first (0th) option, if not configured. Currently only applicable for `type.dropdown`. - ONE-OF: - name: optionIndex | type: integer | description: 0-based index from predefined `controls.inputs.options` which is initial selection. - name: placeholderText | type: string | description: Placeholder hint describing expected choices, such as "Please select". Considered an empty choice. - name: orderIndex | type: integer | description: Field controls are sorted by this value in ascending order. - name: id | type: string | description: Unique control GUID. - name: messages | type: FormMessages | description: Set of defined form messages displayed in the UI before, during, and after a registration flow. Includes the configuration of form titles, response labels, "thank you" messages, and call-to-action texts. - name: rsvp | type: RsvpFormMessages | description: [RSVP form](https://dev.wix.com/docs/rest/business-solutions/events/rsvp-v2/introduction.md) messages. - name: rsvpYesOption | type: string | description: Label text indicating RSVP's `status` is `"YES"`. - name: rsvpNoOption | type: string | description: Label text indicating RSVP's `status` is `"NO"`. - name: positiveMessages | type: Positive | description: Messages displayed when an RSVP's `status` is set to `"YES"`. - name: title | type: string | description: Main form title for positive response. - name: confirmation | type: ResponseConfirmation | description: Confirmation messages shown after registration. - name: title | type: string | description: Confirmation message title. - name: message | type: string | description: Confirmation message text. - name: addToCalendarActionLabel | type: string | description: "Add to calendar" call-to-action label text. - name: shareActionLabel | type: string | description: "Share event" call-to-action label text. - name: waitlistMessages | type: Positive | description: Messages displayed when an RSVP's `status` is set to `"WAITLIST"`, for when the event is full and a waitlist is available). - name: negativeMessages | type: Negative | description: Messages displayed when an RSVP's `status` is set to `"NO"`. - name: title | type: string | description: Main form title for negative response. - name: confirmation | type: ResponseConfirmation | description: Confirmation messages shown after registration. - name: title | type: string | description: Confirmation message title. - name: shareActionLabel | type: string | description: "Share event" call-to-action label text. - name: submitActionLabel | type: string | description: "Submit form" call-to-action label text. - name: checkout | type: CheckoutFormMessages | description: Checkout form messages. - name: title | type: string | description: Main form title for response. - name: submitActionLabel | type: string | description: Submit form call-to-action label text. - name: confirmation | type: ResponseConfirmation | description: Confirmation messages shown after checkout. - name: title | type: string | description: Confirmation message title. - name: message | type: string | description: Confirmation message text. - name: downloadTicketsLabel | type: string | description: "Download tickets" call-to-action label text. - name: addToCalendarLabel | type: string | description: "Add to calendar" call-to-action label text. - name: shareEventLabel | type: string | description: "Share event" call-to-action label text. - name: registrationClosed | type: RegistrationClosedMessages | description: Messages shown when event registration is closed. - name: message | type: string | description: Message shown when event registration is closed. - name: exploreEventsActionLabel | type: string | description: "Explore other events" call-to-action label text. - name: ticketsUnavailable | type: TicketsUnavailableMessages | description: Messages shown when event tickets are unavailable. - name: message | type: string | description: Message shown when event tickets are unavailable. - name: exploreEventsActionLabel | type: string | description: "Explore other events" call-to-action label text. - name: summaries | type: Summaries | description: Summary of RSVP or ticket sales.
**Note:** This field is returned only when the `DASHBOARD` fieldset is included in the request and you have the "WIX_EVENTS.READ_EVENT_DASHBOARD" permissions. - name: rsvps | type: Rsvps | description: RSVP summary of guests. - name: tickets | type: Tickets | description: Summary of revenue and sold tickets. Archived orders aren't included. - name: guestListSettings | type: GuestListSettings | description: Guest list configuration. - name: displayedPublicly | type: boolean | description: Whether the guest list is displayed publicly to all guests. - name: onlineConferencing | type: OnlineConferencing | description: Online conferencing details.
**Note:** This field is returned only when the `ONLINE_CONFERENCING_SESSION` fieldset is included in the request and you have the "WIX_EVENTS.READ_ONLINE_CONFERENCING" permissions. - name: enabled | type: boolean | description: Whether online conferencing is enabled. Not applicable for events where date and time are TBD. When enabled, links to join the conference are generated and provided to guests. - name: providerId | type: string | description: Conference host GUID. - name: type | type: Type | description: Conference type. - enum: - MEETING: Guests can do some actions during the conference, for example talk, turn on their camera and show their screen. - WEBINAR: Guests can only watch the conference. - name: session | type: OnlineConferencingSession | description: Online conferencing session information. - name: seoSettings | type: SeoSettings | description: SEO settings.
**Note:** This field is returned only when the `SEO_SETTINGS` fieldset is included in the request. - name: slug | type: string | description: URL slug. - name: advancedSeoData | type: SeoSchema | description: Advanced SEO data. - name: tags | type: array | description: SEO tag information. - name: type | type: string | description: SEO tag type. Supported values: `title`, `meta`, `script`, `link`. - name: props | type: object | description: A `{"key": "value"}` pair object where each SEO tag property (`"name"`, `"content"`, `"rel"`, `"href"`) contains a value. For example: `{"name": "description", "content": "the description itself"}`. - name: meta | type: object | description: SEO tag metadata. For example, `{"height": 300, "width": 240}`. - name: children | type: string | description: SEO tag inner content. For example, ` inner content `. - name: custom | type: boolean | description: Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages). - name: disabled | type: boolean | description: Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines. - name: settings | type: Settings | description: SEO general settings. - name: preventAutoRedirect | type: boolean | description: Whether the [automatical redirect visits](https://support.wix.com/en/article/customizing-your-pages-seo-settings-in-the-seo-panel) from the old URL to the new one is enabled. Default: `false` (automatical redirect is enabled). - name: keywords | type: array | description: User-selected keyword terms for a specific page. - name: term | type: string | description: Keyword value. - name: isMain | type: boolean | description: Whether the keyword is the main focus keyword. - name: origin | type: string | description: The source that added the keyword terms to the SEO settings. - name: agendaSettings | type: AgendaSettings | description: Event schedule details.
**Note:** This field is returned only when the `AGENDA` fieldset is included in the request. - name: enabled | type: boolean | description: Whether the schedule is enabled for the event. - name: eventDisplaySettings | type: EventDisplaySettings | description: Visual settings for event. - name: hideEventDetailsButton | type: boolean | description: Whether event details button is hidden. Only available for events with no registration. - name: hideEventDetailsPage | type: boolean | description: Disables event details page visibility. If event has an external registration configured visitors will be redirected from this page. - name: description | type: RichContent | description: Event description. Fallback Message for SSR and Error - name: nodes | type: array | description: Node objects representing a rich content document. - ONE-OF: - name: buttonData | type: ButtonData | description: Data for a button node. - name: containerData | type: PluginContainerData | description: Styling for the button's container. - name: width | type: Width | description: The width of the node when it's displayed. - ONE-OF: - name: size | type: Type | description: One of the following predefined width options: `CONTENT`: The width of the container matches the content width. `SMALL`: A small width. `ORIGINAL`: For `imageData` containers only. The width of the container matches the original image width. `FULL_WIDTH`: For `imageData` containers only. The image container takes up the full width of the screen. - enum: - CONTENT: Width matches the content width - SMALL: Small Width - ORIGINAL: Width will match the original asset width - FULL_WIDTH: coast-to-coast display - name: custom | type: string | description: A custom width value in pixels. - name: alignment | type: Alignment | description: The node's alignment within its container. - enum: - CENTER: Center Alignment - LEFT: Left Alignment - RIGHT: Right Alignment - name: spoiler | type: Spoiler | description: Spoiler cover settings for the node. - name: enabled | type: boolean | description: Sets whether the spoiler cover is enabled for this node. Defaults to `false`. - name: description | type: string | description: The description displayed on top of the spoiler cover. - name: buttonText | type: string | description: The text for the button used to remove the spoiler cover. - name: height | type: Height | description: The height of the node when it's displayed. - name: custom | type: string | description: A custom height value in pixels. - name: textWrap | type: boolean | description: Sets whether text should wrap around this node when it's displayed. If `textWrap` is `false`, the node takes up the width of its container. Defaults to `true` for all node types except 'DIVIVDER' where it defaults to `false`. - name: type | type: Type | description: The button type. - enum: - LINK: Regular link button - ACTION: Triggers custom action that is defined in plugin configuration by the consumer - name: styles | type: Styles | description: Styling for the button. - name: borderWidth | type: integer | description: Border width in pixels. - name: borderRadius | type: integer | description: Border radius in pixels. - name: borderColor | type: string | description: Border color as a hexadecimal value. - name: borderColorHover | type: string | description: Border color as a hexadecimal value (hover state). - name: textColor | type: string | description: Text color as a hexadecimal value. - name: textColorHover | type: string | description: Text color as a hexadecimal value (hover state). - name: buttonSize | type: string | description: Button size option, one of `SMALL`, `MEDIUM` or `LARGE`. Defaults to `MEDIUM`. - name: background | type: Background | description: Background styling (color or gradient). - name: type | type: Type | description: Background type. - enum: - COLOR: Solid color background - GRADIENT: Gradient background - name: color | type: string | description: Background color as a hexadecimal value. - name: gradient | type: Gradient | description: Gradient configuration. - name: type | type: Type | description: Gradient type. - enum: - LINEAR: Linear gradient. - RADIAL: Radial gradient. - name: stops | type: array | description: Color stops for the gradient. - name: color | type: string | description: Stop color as hex value. - name: position | type: number | description: Stop position (0-1). - name: angle | type: integer | description: Angle in degrees for linear gradient (0-360). - name: centerX | type: number | description: Horizontal center position for radial gradient (0-100). - name: centerY | type: number | description: Vertical center position for radial gradient (0-100). - name: backgroundHover | type: Background | description: Background styling for hover state (color or gradient). - name: text | type: string | description: The text to display on the button. - name: link | type: Link | description: Button link details. - ONE-OF: - name: url | type: string | description: The absolute URL for the linked document. - name: anchor | type: string | description: The target node's GUID. Used for linking to another node in this object. - name: target | type: Target | description: he HTML `target` attribute value for the link. This property defines where the linked document opens as follows: `SELF` - Default. Opens the linked document in the same frame as the link. `BLANK` - Opens the linked document in a new browser tab or window. `PARENT` - Opens the linked document in the link's parent frame. `TOP` - Opens the linked document in the full body of the link's browser tab or window. - enum: - SELF: Opens the linked document in the same frame as it was clicked (this is default) - BLANK: Opens the linked document in a new window or tab - PARENT: Opens the linked document in the parent frame - TOP: Opens the linked document in the full body of the window - name: rel | type: Rel | description: The HTML `rel` attribute value for the link. This object specifies the relationship between the current document and the linked document. - name: nofollow | type: boolean | description: Indicates to search engine crawlers not to follow the link. Defaults to `false`. - name: sponsored | type: boolean | description: Indicates to search engine crawlers that the link is a paid placement such as sponsored content or an advertisement. Defaults to `false`. - name: ugc | type: boolean | description: Indicates that this link is user-generated content and isn't necessarily trusted or endorsed by the page’s author. For example, a link in a fourm post. Defaults to `false`. - name: noreferrer | type: boolean | description: Indicates that this link protect referral information from being passed to the target website. - name: customData | type: string | description: A serialized object used for a custom or external link panel. - name: codeBlockData | type: CodeBlockData | description: Data for a code block node. - name: textStyle | type: TextStyle | description: Styling for the code block's text. - name: textAlignment | type: TextAlignment | description: Text alignment. Defaults to `AUTO`. - enum: - AUTO: browser default, eqivalent to `initial` - LEFT: Left align - RIGHT: Right align - CENTER: Center align - JUSTIFY: Text is spaced to line up its left and right edges to the left and right edges of the line box, except for the last line - name: lineHeight | type: string | description: A CSS `line-height` value for the text expressed as a ratio relative to the font size. For example, if the font size is 20px, a `lineHeight` value of `'1.5'`` results in a line height of 30px. - name: dividerData | type: DividerData | description: Data for a divider node. - name: containerData | type: PluginContainerData | description: Styling for the divider's container. - name: lineStyle | type: LineStyle | description: Divider line style. - enum: - SINGLE: Single Line - DOUBLE: Double Line - DASHED: Dashed Line - DOTTED: Dotted Line - name: width | type: Width | description: Divider width. - enum: - LARGE: Large line - MEDIUM: Medium line - SMALL: Small line - name: alignment | type: Alignment | description: Divider alignment. - enum: - CENTER: Center alignment - LEFT: Left alignment - RIGHT: Right alignment - name: fileData | type: FileData | description: Data for a file node. - name: containerData | type: PluginContainerData | description: Styling for the file's container. - name: src | type: FileSource | description: The source for the file's data. - ONE-OF: - name: url | type: string | description: The absolute URL for the file's source. - name: id | type: string | description: An GUID that's resolved to a URL by a resolver function. - name: private | type: boolean | description: Indicates whether the file's source is private. Defaults to `false`. - name: name | type: string | description: File name. - name: type | type: string | description: File type. - name: pdfSettings | type: PDFSettings | description: Settings for PDF files. - name: viewMode | type: ViewMode | description: PDF view mode. One of the following: `NONE` : The PDF isn't displayed. `FULL` : A full page view of the PDF is displayed. `MINI` : A mini view of the PDF is displayed. - enum: - NONE: No PDF view - FULL: Full PDF view - MINI: Mini PDF view - name: disableDownload | type: boolean | description: Sets whether the PDF download button is disabled. Defaults to `false`. - name: disablePrint | type: boolean | description: Sets whether the PDF print button is disabled. Defaults to `false`. - name: mimeType | type: string | description: File MIME type. - name: path | type: string | description: File path. - name: sizeInKb | type: string | description: File size in KB. - name: galleryData | type: GalleryData | description: Data for a gallery node. - name: containerData | type: PluginContainerData | description: Styling for the gallery's container. - name: items | type: array | description: The items in the gallery. - ONE-OF: - name: image | type: Image | description: An image item. - name: media | type: Media | description: Image file details. - name: src | type: FileSource | description: The source for the media's data. - name: width | type: integer | description: Media width in pixels. - name: height | type: integer | description: Media height in pixels. - name: duration | type: number | description: Media duration in seconds. Only relevant for audio and video files. - name: link | type: Link | description: Link details for images that are links. - name: video | type: Video | description: A video item. - name: media | type: Media | description: Video file details. - name: thumbnail | type: Media | description: Video thumbnail file details. - name: title | type: string | description: Item title. - name: altText | type: string | description: Item's alternative text. - name: options | type: GalleryOptions | description: Options for defining the gallery's appearance. - name: layout | type: Layout | description: Gallery layout. - name: type | type: Type | description: Gallery layout type. - enum: - COLLAGE: Collage type - MASONRY: Masonry type - GRID: Grid type - THUMBNAIL: Thumbnail type - SLIDER: Slider type - SLIDESHOW: Slideshow type - PANORAMA: Panorama type - COLUMN: Column type - MAGIC: Magic type - FULLSIZE: Fullsize images type - name: horizontalScroll | type: boolean | description: Sets whether horizontal scroll is enabled. Defaults to `true` unless the layout `type` is set to `GRID` or `COLLAGE`. - name: orientation | type: Orientation | description: Gallery orientation. - enum: - ROWS: Rows Orientation - COLUMNS: Columns Orientation - name: numberOfColumns | type: integer | description: The number of columns to display on full size screens. - name: mobileNumberOfColumns | type: integer | description: The number of columns to display on mobile screens. - name: item | type: ItemStyle | description: Styling for gallery items. - name: targetSize | type: integer | description: Desirable dimension for each item in pixels (behvaior changes according to gallery type) - name: ratio | type: number | description: Item ratio - name: crop | type: Crop | description: Sets how item images are cropped. - enum: - FILL: Crop to fill - FIT: Crop to fit - name: spacing | type: integer | description: The spacing between items in pixels. - name: thumbnails | type: Thumbnails | description: Styling for gallery thumbnail images. - name: placement | type: Alignment | description: Thumbnail alignment. - enum: - TOP: Top alignment - RIGHT: Right alignment - BOTTOM: Bottom alignment - LEFT: Left alignment - NONE: No thumbnail - name: spacing | type: integer | description: Spacing between thumbnails in pixels. - name: disableExpand | type: boolean | description: Sets whether the gallery's expand button is disabled. Defaults to `false`. - name: disableDownload | type: boolean | description: Sets whether the gallery's download button is disabled. Defaults to `false`. - name: gifData | type: GIFData | description: Data for a GIF node. - name: containerData | type: PluginContainerData | description: Styling for the GIF's container. - name: original | type: GIF | description: The source of the full size GIF. - name: gif | type: string | description: GIF format URL. - name: mp4 | type: string | description: MP4 format URL. - name: still | type: string | description: Thumbnail URL. - name: downsized | type: GIF | description: The source of the downsized GIF. - name: height | type: integer | description: Height in pixels. - name: width | type: integer | description: Width in pixels. - name: gifType | type: GIFType | description: Type of GIF (Sticker or NORMAL). Defaults to `NORMAL`. - enum: NORMAL, STICKER - name: headingData | type: HeadingData | description: Data for a heading node. - name: level | type: integer | description: Heading level from 1-6. - name: textStyle | type: TextStyle | description: Styling for the heading text. - name: indentation | type: integer | description: Indentation level from 1-4. - name: renderedLevel | type: integer | description: Rendered heading level for SEO/accessibility, overrides the HTML tag when set. - name: htmlData | type: HTMLData | description: Data for an embedded HTML node. - ONE-OF: - name: url | type: string | description: The URL for the HTML code for the node. - name: html | type: string | description: The HTML code for the node. - name: widgetId | type: string | description: The WixelWidget GUID for AI_WIDGET source nodes. - name: containerData | type: PluginContainerData | description: Styling for the HTML node's container. Height property is irrelevant for HTML embeds when autoHeight is set to `true`. - name: source | type: Source | description: The type of HTML code. - enum: HTML, ADSENSE, AI, AI_WIDGET - name: autoHeight | type: boolean | description: If container height is aligned with its content height. Defaults to `true`. - name: imageData | type: ImageData | description: Data for an image node. - name: containerData | type: PluginContainerData | description: Styling for the image's container. - name: image | type: Media | description: Image file details. - name: link | type: Link | description: Link details for images that are links. - name: disableExpand | type: boolean | description: Sets whether the image expands to full screen when clicked. Defaults to `false`. - name: altText | type: string | description: Image's alternative text. - name: disableDownload | type: boolean | description: Sets whether the image's download button is disabled. Defaults to `false`. - name: decorative | type: boolean | description: Sets whether the image is decorative and does not need an explanation. Defaults to `false`. - name: styles | type: Styles | description: Styling for the image. - name: border | type: Border | description: Border attributes. - name: width | type: integer | description: Border width in pixels. - name: color | type: string | description: Border color as a hexadecimal value. - name: radius | type: integer | description: Border radius in pixels. - name: linkPreviewData | type: LinkPreviewData | description: Data for a link preview node. - name: containerData | type: PluginContainerData | description: Styling for the link preview's container. - name: link | type: Link | description: Link details. - name: title | type: string | description: Preview title. - name: thumbnailUrl | type: string | description: Preview thumbnail URL. - name: description | type: string | description: Preview description. - name: html | type: string | description: The preview content as HTML. - name: styles | type: Styles | description: Styling for the link preview. - name: backgroundColor | type: string | description: Background color as a hexadecimal value. - name: titleColor | type: string | description: Title color as a hexadecimal value. - name: subtitleColor | type: string | description: Subtitle color as a hexadecimal value. - name: linkColor | type: string | description: Link color as a hexadecimal value. - name: borderWidth | type: integer | description: Border width in pixels. - name: borderRadius | type: integer | description: Border radius in pixels. - name: borderColor | type: string | description: Border color as a hexadecimal value. - name: thumbnailPosition | type: Position | description: Position of thumbnail. Defaults to `START`. - enum: - START: Thumbnail positioned at the start (left in LTR layouts, right in RTL layouts) - END: Thumbnail positioned at the end (right in LTR layouts, left in RTL layouts) - TOP: Thumbnail positioned at the top - HIDDEN: Thumbnail hidden and not displayed - name: paragraphData | type: ParagraphData | description: Data for a paragraph node. - name: textStyle | type: TextStyle | description: Styling for the paragraph text. - name: indentation | type: integer | description: Indentation level from 1-4. - name: level | type: integer | description: Paragraph level - name: pollData | type: PollData | description: Data for a poll node. - name: containerData | type: PluginContainerData | description: Styling for the poll's container. - name: poll | type: Poll | description: Poll data. - name: id | type: string | description: Poll GUID. - name: title | type: string | description: Poll title. - name: creatorId | type: string | description: Poll creator GUID. - name: image | type: Media | description: Main poll image. - name: options | type: array