Updates banner content and display settings including image, dimensions, description, and purchase type.
Updates banner content and display settings including image, dimensions, description, and purchase type.
When the flow reaches this step, JOrchestrator executes Update Banner against your linked site or an external integration, using the field values you set on General and Design. Downstream steps can read the output payload fields defined for this node.
Update Banner is a action step in the Banners group. Action steps run in the middle or end of a flow. They perform work on your CMS, call external services, or transform data for the next step.
Typical reasons teams add Update Banner to a flow:
Common patterns on the canvas:
Select banner by id; optional fields leave existing values unchanged.
Sticky vs. standard banner type affects layout on the frontend module.
The designer shows these tabs for this node:
| Tab | Purpose |
|---|---|
| Info | Plain-language description and output payload fields for downstream steps |
| General | Canvas label and read-only node ID |
| AI | Optional assistant to help draft settings from plain language |
| Design | Node-specific configuration fields |
These fields are managed by the designer or runtime — you do not type into them directly:
| Property key | Label | Type | Required | Visible when | Notes |
|---|---|---|---|---|---|
_nodeId | Node ID | node-id | No | — | — |
_payloadFields | Available Fields | payload-panel | No | — | — |
_customHtmlClickNote | Custom HTML click-through | field-hint | No | bannerType === '1' | In Custom HTML mode, you must add an onclick handler on an HTML tag of your choice (for example onclick="window.open('https://example.com')"). The Click URL field is hidden and not used — wire the destination in your markup. |
| Property key | Label | Type | Required | Visible when | Notes |
|---|---|---|---|---|---|
label | Label | text | No | — | Node label |
| Property key | Label | Type | Required | Visible when | Notes |
|---|---|---|---|---|---|
name | Name | payload-text | No | — | Banner name or drag payload field |
bannerType | Type | select (0 | 1; default: 0) | No | — | — |
width | Width | number | No | bannerType === '0' | Leave blank for image width |
height | Height | number | No | bannerType === '0' | Leave blank for image height |
clickurl | Click URL | payload-text | No | bannerType === '0' | URL when banner is clicked |
description | Description HTML | wysiwyg | No | — | Banner description (HTML supported) |
custombannercode | Custom HTML | wysiwyg | No | bannerType === '1' | Enter your custom banner HTML |
maximpressions | Max Impressions | number | No | — | 0 = unlimited |
purchasetype | Purchase Type | select (-1 | 0 | 1 | 2 | 3 | 4; default: -1) | No | — | — |
state | Published Status | select (0 | 1 | 2 | -2; default: 1) | No | — | — |
publish_up | Start Publishing | datetime | No | — | When to start showing |
publish_down | Finish Publishing | datetime | No | — | When to stop showing |
created | Created Date | datetime | No | — | Creation date |
created_by_alias | Created by Alias | text | No | — | Author alias |
modified | Modified Date | datetime | No | — | Last modified date |
| Property key | Label | Type | Required | Visible when | Notes |
|---|---|---|---|---|---|
catid | Banner Category | banner-category-select | No | — | Select category to filter banners |
id | Banner to Update | banner-select | Yes | — | Select banner |
url | Image | image-select | No | bannerType === '0' | Select image from Joomla |
cid | Client | banner-client-select | No | — | Select banner client |
created_by | Created By | user-select | No | — | Select user |
modified_by | Modified By | user-select | No | — | Select user |
Credentials, API keys, mailers, SMTP, and integration defaults are configured in the CMS plugin under Node Configuration, not per step on this node. Link the flow to a domain before testing CMS-backed fields.
After this step runs, later nodes can reference these fields using placeholders such as {{update_banner.id}}.
| Field key | Type | Description |
|---|---|---|
id | string | Primary record identifier. |
name | string | Display name of the record. |
state | number | Published state (0 = unpublished, 1 = published). |
url | string | Public HTTP URL to a resource on the site. |
clickurl | string | Banner click-through URL. |
Other steps in the same area of the palette:
create-banner) — Bannersdelete-banner) — Bannerspublish-banner) — Banners