Book screens
advertiser.bookings.createBook a quote with a creative. Spending limits are enforced. Depending on the account's approval rules the booking is paid at once with the saved card, returns a payment_url for the account holder, or waits for the account holder (the advertiser whose account this is, never the venue) to approve it by email (status awaiting_approval). Once paid, the booking is scheduled at once: venues take no part in booking and can only report an advert already showing on their screen. Some categories (alcohol, gambling, political, cannabis, tobacco_and_vaping, dating) are checked by Wall Marketing staff first. Read next_step in the result. Repeating the call with the same idempotency key never books twice.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| category | Yes | What the advert is for; sensitive categories are checked by staff first. | |
| quote_id | Yes | From advertiser.bookings.quote; used once, within 30 minutes. | |
| creative_id | Yes | From bookings.upload_artwork. | |
| campaign_name | Yes | A name for the campaign, shown on invoices and reports. | |
| idempotency_key | No | Any unique string; reuse it when retrying the same booking. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | The booking_id. | |
| error | No | Present instead of the other fields when the call failed. | |
| object | No | Always "booking". | |
| status | No | One of: awaiting_approval, in_review, awaiting_payment, payment_expired, scheduled, live, finished, declined, cancelled. | |
| payment | No | Payment state. | |
| approval | No | The account holder's approval and any staff check. | |
| category | No | The advert's category. | |
| currency | No | Always "usd". | |
| livemode | No | False in the sandbox. | |
| quote_id | No | The quote it was booked from. | |
| next_step | No | Plain-language instruction for what happens or what to do next. | |
| total_usd | No | Total price in US dollars. | |
| created_at | No | When it was booked. ISO 8601, UTC. | |
| placements | No | One per venue, with its dates and state. | |
| report_url | No | Proof-of-display report (REST). | |
| updated_at | No | Last change. ISO 8601, UTC. | |
| creative_id | No | The artwork shown. | |
| campaign_name | No | The campaign name. | |
| status_reason | No | Why it is declined or cancelled, if it is. | |
| order_reference | No | Wall Marketing's order reference once paid. | |
| cancellation_requested_at | No | When cancellation of a paid booking was requested. ISO 8601, UTC. |