Buttondown logo

Creating an advertising unit

Create a new advertising unit. Pass a list of dates to automatically open advertising slots on each of those days.

Sample requests

These sample requests are autogenerated by the OpenAPI spec.

import requests

url = "https://api.buttondown.com/v1/advertising_units"
headers = {
  "Authorization": "Token $BUTTONDOWN_API_KEY"
}

response = requests.request("POST", url, headers=headers)
print(response.text)

Sample responses

The IDs and values referenced in these responses are fake; please only rely on these responses for overall structure.

{
    "id": "adsku_0k28edc3fw896bp4mrhc535z5k",
    "creation_date": "2024-01-01T00:00:00+00:00",
    "status": "active",
    "title": "Sponsored Link",
    "description": "A sponsored link in the newsletter",
    "behavior": "",
    "url": "",
    "price": 5000,
    "allows_html": false,
    "allows_image": false,
    "max_characters": 280,
    "submission_deadline_days": 3,
    "slots": [
        {
            "id": "adslot_1328edc3fw896bp4mrhc535z5k",
            "creation_date": "2024-01-01T00:00:00+00:00",
            "date": "2024-12-01",
            "status": "open",
            "invoice_url": null,
            "sku_id": "adsku_0k28edc3fw896bp4mrhc535z5k",
            "submission_url": "http://127.0.0.1:8000/example/sponsorships/submit/11111111-1111-1111-1111-111111111111/",
            "sponsor_company": "",
            "sponsor_email": "",
            "sponsor_name": "",
            "content": "",
            "content_image_id": null,
            "content_url": "",
            "content_approved_at": null,
            "content_rejected_at": null,
            "content_rejection_reason": "",
            "content_submitted_at": null,
            "inquiry_message": ""
        },
        {
            "id": "adslot_1k28edc3fw896bp4mrhc535z5k",
            "creation_date": "2024-01-01T00:00:00+00:00",
            "date": "2024-11-15",
            "status": "sold",
            "invoice_url": null,
            "sku_id": "adsku_0k28edc3fw896bp4mrhc535z5k",
            "submission_url": "http://127.0.0.1:8000/example/sponsorships/submit/22222222-2222-2222-2222-222222222222/",
            "sponsor_company": "Acme Corp",
            "sponsor_email": "sponsor@acme.com",
            "sponsor_name": "John Doe",
            "content": "Check out our amazing product!",
            "content_image_id": null,
            "content_url": "https://acme.com/product",
            "content_approved_at": "2024-11-10T00:00:00+00:00",
            "content_rejected_at": null,
            "content_rejection_reason": "",
            "content_submitted_at": "2024-11-08T00:00:00+00:00",
            "inquiry_message": ""
        }
    ]
}

Body parameters

All parameters are optional unless explicitly specified.

title

Type
string
Description

The title of the advertising unit.

description

Type
string
Description

A description of the advertising unit.

behavior

Type
string
Description

The behavior type of the advertising unit.

url

Type
string
Description

The URL for the advertising unit's landing page.

price

Type
integer
Description

The price in the smallest currency unit.

allows_html

Type
boolean
Description

Whether the advertising unit accepts HTML content.

allows_image

Type
boolean
Description

Whether the advertising unit accepts an image.

max_characters

Type
integer
Description

Maximum number of characters allowed for the ad content.

submission_deadline_days

Type
integer
Description

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