v4

latestOpenAPI 3.1.0MIT2026-08-02128224900.7 KB

Advertising Units

Update Advertising Unit

Update an advertising unit's properties

patch/advertising_units/{id}

Path parameters

idstring required

Request body

titlestring nullable

The title of the advertising unit.

descriptionstring nullable

A description of the advertising unit.

datesstring[] required

The dates for this advertising unit's slots.

behaviorstring nullable

The behavior type of the advertising unit.

urlstring nullable

The URL for the advertising unit's landing page.

priceinteger nullable

The price in the smallest currency unit.

allows_htmlboolean nullable

Whether the advertising unit accepts HTML content.

allows_imageboolean nullable

Whether the advertising unit accepts an image.

max_charactersinteger nullable

Maximum number of characters allowed for the ad content.

submission_deadline_daysinteger nullable

Number of days before the slot date that content must be submitted.

Response

idstring required

A unique TypeID associated with the object.

creation_datestring date-time required

The date and time at which the object was first created.

status'active' | 'inactive' required

An enumeration.

titlestring required

The title of the advertising unit.

descriptionstring required

A description of the advertising unit.

behaviorstring required

The behavior type of the advertising unit.

urlstring required

The URL for the advertising unit's landing page.

priceinteger nullable

The price in the smallest currency unit, or null if not set.

allows_htmlboolean required

Whether the advertising unit accepts HTML content.

allows_imageboolean required

Whether the advertising unit accepts an image.

max_charactersinteger nullable

Maximum number of characters allowed for the ad content.

submission_deadline_daysinteger required

Number of days before the slot date that content must be submitted.