BUbuttondown
Advertising Units

Update Advertising Slot

Changed on

Update an advertising slot's sponsor content

patch/advertising_units/slots/{id}

Request

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

Path parameters

idstring required

Request body

contentstring nullable

The ad content text.

content_approved_atstring date-time nullable

When the ad content was approved.

content_image_idstring nullable

The ID of the image attached to this ad.

content_rejection_reasonstring nullable

The reason the ad content was rejected.

content_urlstring nullable

The URL the ad links to.

sponsor_companystring nullable

The name of the sponsoring company.

sponsor_emailstring nullable

The email address of the sponsor contact.

sponsor_namestring nullable

The name of the sponsor contact.

status'approve' | 'hold_accept' | 'hold_decline' | 'reject' nullable

Set to 'approve', 'reject', 'hold_accept', or 'hold_decline' to update the slot status.

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.

datestring date required

The date this advertising slot is scheduled for.

status'expired' | 'executed' | 'finalized' | 'held' | 'open' | 'sold' required

An enumeration.

invoice_urlstring nullable

URL to the Stripe invoice PDF for this slot, if available.

sku_idstring required

The ID of the advertising unit this slot belongs to.

submission_urlstring required

URL where the sponsor can submit their ad content.

sponsor_companystring required

The name of the sponsoring company.

sponsor_emailstring required

The email address of the sponsor contact.

sponsor_namestring required

The name of the sponsor contact.

contentstring required

The ad content text.

content_image_idstring nullable

The ID of the image attached to this ad, if any.

content_urlstring required

The URL the ad links to.

content_approved_atstring date-time nullable

When the ad content was approved, if applicable.

content_rejected_atstring date-time nullable

When the ad content was rejected, if applicable.

content_rejection_reasonstring required

The reason the ad content was rejected, if applicable.

content_submitted_atstring date-time nullable

When the ad content was submitted for review.

inquiry_messagestring required

Optional message from the sponsor inquiry.

Changes

  • 228cc05ba97dRevision changes
    • info

      added the non-success response with the status

  • 13f3bc084194Revision changes
    • breaking

      response property 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

      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

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