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

    Interface ActivateSignalRequest

    Request parameters for activating or deactivating a signal on deployment targets

    interface ActivateSignalRequest {
        action?: "activate" | "deactivate";
        signal_agent_segment_id: string;
        destinations: Destination[];
        pricing_option_id?: string;
        account?: AccountReference;
        idempotency_key?: string;
        context?: ContextObject;
        ext?: ExtensionObject;
    }
    Index

    Properties

    action? signal_agent_segment_id destinations pricing_option_id? account? idempotency_key? context? ext?

    Properties

    action?: "activate" | "deactivate"

    Whether to activate or deactivate the signal. Deactivating removes the segment from downstream platforms, required when campaigns end to comply with data governance policies (GDPR, CCPA). Defaults to 'activate' when omitted.

    signal_agent_segment_id: string

    The universal identifier for the signal to activate

    destinations: Destination[]

    Target destination(s) for activation. If the authenticated caller matches one of these destinations, activation keys will be included in the response.

    pricing_option_id?: string

    The pricing option selected from the signal's pricing_options in the get_signals response. Required when the signal has pricing options. Records the buyer's pricing commitment at activation time; pass this same value in report_usage for billing verification.

    account?: AccountReference
    idempotency_key?: string

    Client-generated unique key for this request. Prevents duplicate activations on retries. 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