Bookings

Cancel a booking

Cancels a booking that is not paid yet. For a paid booking it asks Wall Marketing staff to cancel and refund it (a person decides).

post/bookings/{booking_id}/cancel

Request

  • Base URL: https://wall.marketing/api/v1
  • URL: https://wall.marketing/api/v1/bookings/{booking_id}/cancel
  • Auth: HTTP bearer

Path parameters

booking_idstring required

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

reasonstring

Response

Cancelled

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.