Bookings

Book screens

Book 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. Needs scope book. Send the idempotency key as the Idempotency-Key header.

post/bookings

Request

  • Base URL: https://wall.marketing/api/v1
  • URL: https://wall.marketing/api/v1/bookings
  • Auth: HTTP bearer

Headers

Idempotency-Keystring

Repeat a request with the same key to get the first response instead of acting twice. Kept for 24 hours.

Request body

quote_idstring required
creative_idstring required
campaign_namestring required
category'general' | 'food_and_drink' | 'retail' | 'events' | 'local_services' | 'recruitment' | 'real_estate' | 'finance' | 'health' | 'education' | 'travel' | 'technology' | 'nonprofit' | 'alcohol' | 'gambling' | 'political' | 'cannabis' | 'tobacco_and_vaping' | 'dating' required

Response

Created

objectstring

Always "booking".

idstring

The booking_id.

livemodeboolean

False in the sandbox.

statusstring

One of: awaiting_approval, in_review, awaiting_payment, payment_expired, scheduled, live, finished, declined, cancelled.

status_reasonstring nullable

Why it is declined or cancelled, if it is.

next_stepstring

Plain-language instruction for what happens or what to do next.

campaign_namestring

The campaign name.

categorystring nullable

The advert's category.

total_usdnumber

Total price in US dollars.

currencystring

Always "usd".

quote_idstring nullable

The quote it was booked from.

creative_idstring nullable

The artwork shown.

order_referencestring nullable

Wall Marketing's order reference once paid.

cancellation_requested_atstring nullable

When cancellation of a paid booking was requested. ISO 8601, UTC.

report_urlstring

Proof-of-display report (REST).

created_atstring nullable

When it was booked. ISO 8601, UTC.

updated_atstring nullable

Last change. ISO 8601, UTC.

Changes

No recorded changes to this operation across all 1 revision of this API.