Skip to main content
PUT
/
api
/
banners
/
{bannerId}
Update Banner
curl --request PUT \
  --url https://api.cludo.com/api/banners/{bannerId} \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "htmlcode": "<string>",
  "websiteid": 123,
  "bannerterms": [
    {
      "name": "<string>"
    }
  ],
  "isDisabled": true,
  "from": "2023-11-07T05:31:56Z",
  "to": "2023-11-07T05:31:56Z",
  "audiences": [
    "<unknown>"
  ]
}
'
{
  "name": "<string>",
  "htmlcode": "<string>",
  "websiteid": 123,
  "id": 123,
  "bannerterms": [
    {
      "name": "<string>"
    }
  ],
  "isDisabled": true,
  "from": "2023-11-07T05:31:56Z",
  "to": "2023-11-07T05:31:56Z",
  "audiences": [
    "<unknown>"
  ],
  "engineIds": [
    123
  ],
  "frequency": "<string>",
  "daysOfWeek": "<string>",
  "cssCode": "<string>",
  "jsonOption": "<string>",
  "editorType": "<string>",
  "brokenLinksFoundAt": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://cludo.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

Basic authentication. Use your Customer ID as the username and API Key as the password. Example header: Authorization: Basic MTIzNDU2NzpteS1hcGkta2V5.

Path Parameters

bannerId
integer
required

Numeric id of an existing banner (returned by list/get/create).

Body

application/json

Banner update payload. The banner id is taken from the URL path; any id in the body is ignored.

name
string
required

Admin-facing name for the banner.

htmlcode
string
required

Markup to render; validate in staging before production.

websiteid
integer
required

Must match the engine that owns the banner.

bannerterms
object[]

Replace the banner's full trigger list with this array. Send all terms you want to keep — omitted terms are removed.

isDisabled
boolean

When true, the banner is stored but never served.

from
string<date-time> | null
to
string<date-time> | null
audiences
any[] | null

Audience targeting configuration. Omit the field entirely (or send null) when the banner is not audience-targeted.

Response

Banner updated successfully.

name
string
required

Internal label in MyCludo (not shown to end users).

htmlcode
string
required

HTML snippet injected on the SERP when terms match (keep accessible and scoped).

websiteid
integer
required

Search engine ID.

id
integer

Banner ID (assigned by server on create).

bannerterms
object[]

List of trigger phrases; any match can activate the banner depending on engine rules.

isDisabled
boolean

When true, the banner is stored but never served.

from
string<date-time> | null

Start of scheduled display window.

to
string<date-time> | null

End of scheduled display window.

audiences
any[] | null

Audience targeting configuration. Omit the field entirely (or send null) when the banner is not audience-targeted.

engineIds
integer[] | null

Managed by the Cludo backend; informational only.

frequency
string | null

Managed by the Cludo backend; informational only.

daysOfWeek
string | null

Managed by the Cludo backend; informational only.

cssCode
string | null

Managed by the Cludo backend; informational only.

jsonOption
string | null

Managed by the Cludo backend; informational only.

editorType
string | null

Managed by the Cludo backend; informational only.

Timestamp when broken links were last detected, if any.