Create Banner - Cludo API Documentation

curl --request POST \ --url https://api.cludo.com/api/banners \ --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>" }

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.

Body

application/json

Banner payload without id (server assigns id).

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 you are configuring.

bannerterms

object[]

Optional trigger list; omit for banners driven only by audience rules.

Show child attributes

isDisabled

boolean

Create in disabled state to review before go-live.

from

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 created 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.

integer

Banner ID (assigned by server on create).

bannerterms

object[]

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

Show child attributes

isDisabled

boolean

When true, the banner is stored but never served.

from

string<date-time> | null

Start of scheduled display window.

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