Skip to main content

Booking API

Bookings

Bookings determine that what, where, how and when of ad delivery.

Get a single booking

GET /v1/bookings/{bookingId}

Returns a single bookings' details by booking ID.

Request body

Parameter In Required Type Description
InternalId path Yes integer The booking's ID.

Response - 200

{
    "internalId": 22,
    "name": "Evnia 27M2N8500/01",
    "status": "ACTIVE",
    "lifetimeStatus": "STARTED",
    "positionId": 8,
    "positionName": "Home Halfpage",
    "formatId": 1,
    "formatName": "Halfpage",
    "startDate": "2026-07-04T22:00:00Z",
    "endDate": "2026-07-31T21:59:00Z",
    "creationDate": "2026-07-01T10:14:28Z",
    "lastEditedDate": "2026-07-15T13:42:55Z",
    "deliveryFactors": {
        "unit": "IMPRESSIONS",
        "volume": 1500000,
        "pricingType": "CPM",
        "price": 3.0,
        "budget": 4500.0,
        "currency": "EUR",
        "cpcOptimized": true
    },
    "activeDays": [
        "MONDAY",
        "TUESDAY",
        "THURSDAY",
        "FRIDAY",
        "SATURDAY",
        "SUNDAY"
    ],
    "creativeCount": 2,
    "frequencyLimits": [],
    "userFrequencies": [
        {
            "impressionsAmount": 10,
            "expiryInSeconds": 86400
        }
    ],
    "pacing": "FRONTLOADED",
    "deliveryMethod": "AUTO",
    "deliveryParameter": 0.0,
    "deliveryMultiples": "FREE",
    "campaignId": 17,
    "comment": null,
    "priority": null,
    "isBookedOnChannel": false,
    "excludePositionIds": [],
    "excludePublicationIds": [],
    "rtbEnabled": false,
    "targetExpressions": {},
    "autoDeliveryLimits": false,
    "bookingType": null,
    "startTime": "00:00:00",
    "endTime": "23:59:59"
}

Response codes

Status Meaning
200 Booking found.
400 Bad request - invalid input or parameters.
401403 Not authenticated / not allowed.
404 Not Found - Resource not found.
500 Internal Server Error - Unexpected failure.

Update a single booking

Updates a single booking by booking ID.

Request body - UpdateBookingDto

Parameter In Required Type Description
InternalId path Yes integer The booking's ID.
name body Yes string Name of the campaign under which the booking is active.
startDate body Yes string Start date of the booking in date-time format yyyy-mm-ddThh:mm:ssZ
endDate body Yes string End date of the booking in date-time format yyyy-mm-ddThh:mm:ssZ

activeDays

body Yes string Days of the week the booking is active. Possible values are: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY

deliveryFactors

body Yes string, integer, number, boolean Options that set the goals and to reach of the booking.

- unit

body Yes string Unit of the to reach volume of the booking. Possible values are: Impressions or Clicks

- volume

body No integer Amount of the unit to reach before the booking stops.

- price

body No number Price of the booking set by pricing type.

- budget

body No number Budget of the booking. When the budget is spent by the booking, delivery stops.

- pricingType

body Yes string Method for determining ad spend via price. Possible values are: CPM, CPC, CPP, CPL or ADM

- cpcOptimized

body No boolean Is CPC optimisation enabled for the booking: true or false

mediaProduct

body Yes Integer Position and format ID of the position of the booking.

- positionID

body Yes Integer Slot ID of the position.

- formatID

body Yes Integer ID of the format used in the position.

frequencyLimits

body No Integer, String Setting for capping delivery.

- amount

body No String Amount of event to cap delivery by.

- event

body No String Unit to measure for capping delivery. Either IMPRESSIONS or CLICKS

- period

body No String Period where the cap is active, either HOURLY or DAILY. After the period has run out, the cap resets, either for the next hour or next day.

pacing


body

YES

String

Delivery pacing options for the booking. Possible values are: EVEN, FRONTLOADED, AS_FAST_AS_POSSIBLE, ROTATION, SHARE_OF_VOICE or ACCOUNT_SETTING. Account setting takes the default pacing option set for the account