BUbuttondown
Advertising Units

Update Advertising Unit

Changed on

Update an advertising unit's properties

patch/advertising_units/{id}

Request

  • Base URL
    https://api.buttondown.com/v1
  • URL
    https://api.buttondown.com/v1/advertising_units/{id}
  • Auth
    API key in header Authorization

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

OK

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.

Changes

  • 228cc05ba97dRevision changes
    • info

      added the non-success response with the status

  • 13f3bc084194Revision changes
    • breaking

      response property price list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property slots/items/invoice_url list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      the response's property type changed from no type to string for status

    • breaking

      the response's property type changed from no type to string for status

    • warning

      added the new held enum value to the // response property for the response status

    • info

      the endpoint scheme security ApiKeyAuth was added to the API

    • info

      the endpoint scheme security PermissionAuthenticationRequirement was removed from the API

    • info

      api tag Advertising Units added

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      request property list-of-types was widened by adding types null to media type application/json

    • info

      request property list-of-types was widened by adding types null to media type application/json

    • info

      request property list-of-types was widened by adding types null to media type application/json

    • info

      request property list-of-types was widened by adding types null to media type application/json

    • info

      request property list-of-types was widened by adding types null to media type application/json

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property to the response with the status