@adcp/client API Reference - v4.19.0
    Preparing search index...

    Interface UpdateMediaBuyRequest

    Request parameters for updating campaign and package settings

    interface UpdateMediaBuyRequest {
        media_buy_id: string;
        revision?: number;
        paused?: boolean;
        canceled?: true;
        cancellation_reason?: string;
        start_time?: string;
        end_time?: string;
        packages?: PackageUpdate[];
        invoice_recipient?: BusinessEntity;
        new_packages?: PackageRequest[];
        reporting_webhook?: ReportingWebhook;
        push_notification_config?: PushNotificationConfig;
        idempotency_key?: string;
        context?: ContextObject;
        ext?: ExtensionObject;
    }
    Index

    Properties

    media_buy_id revision? paused? canceled? cancellation_reason? start_time? end_time? packages? invoice_recipient? new_packages? reporting_webhook? push_notification_config? idempotency_key? context? ext?

    Properties

    media_buy_id: string

    Seller's ID of the media buy to update

    revision?: number

    Expected current revision for optimistic concurrency. When provided, sellers MUST reject the update with CONFLICT if the media buy's current revision does not match. Obtain from get_media_buys or the most recent update response.

    paused?: boolean

    Pause/resume the entire media buy (true = paused, false = active)

    canceled?: true

    Cancel the entire media buy. Cancellation is irreversible — canceled media buys cannot be reactivated. Sellers MAY reject with NOT_CANCELLABLE if the media buy cannot be canceled in its current state.

    cancellation_reason?: string

    Reason for cancellation. Sellers SHOULD store this and return it in subsequent get_media_buys responses.

    start_time?: string
    end_time?: string

    New end date/time in ISO 8601 format

    packages?: PackageUpdate[]

    Package-specific updates for existing packages

    invoice_recipient?: BusinessEntity
    new_packages?: PackageRequest[]

    New packages to add to this media buy. Uses the same schema as create_media_buy packages. Sellers that support mid-flight package additions advertise add_packages in valid_actions. Sellers that do not support this MUST reject with UNSUPPORTED_FEATURE.

    reporting_webhook?: ReportingWebhook
    push_notification_config?: PushNotificationConfig
    idempotency_key?: string

    Client-generated idempotency key for safe retries. If an update fails without a response, resending with the same idempotency_key guarantees the update is applied at most once. MUST be unique per (seller, request) pair to prevent cross-seller correlation. Use a fresh UUID v4 for each request.

    context?: ContextObject
    ext?: ExtensionObject

    Settings

    Member Visibility

    On This Page

    Properties