@adcp/sdk API Reference - v10.0.1
    Preparing search index...

    Interface UpdatePropertyListRequest

    Request parameters for updating an existing property list

    interface UpdatePropertyListRequest {
        adcp_version?: string;
        adcp_major_version?: number;
        list_id: string;
        account?: AccountReference;
        name?: string;
        description?: string;
        base_properties?: BasePropertySource[];
        filters?: PropertyListFilters;
        brand?: BrandReference;
        webhook_url?: string;
        context?: ContextObject;
        ext?: ExtensionObject;
        idempotency_key: string;
    }
    Index

    Properties

    adcp_version? adcp_major_version? list_id account? name? description? base_properties? filters? brand? webhook_url? context? ext? idempotency_key

    Properties

    adcp_version?: string

    Release-precision AdCP version (VERSION.RELEASE, e.g. "3.0", "3.1", "3.1-beta"). On a request: the buyer's release pin — the seller validates against its supported_versions and returns VERSION_UNSUPPORTED on cross-major mismatch, or downshifts to the highest supported release within the same major. On a response: the release the seller actually served — clients SHOULD validate the response against that release's schema, not against their pin. Patches are not negotiated; surface them as build_version on capabilities for operational visibility. When omitted, falls back to adcp_major_version (deprecated) or server default. Buyers SHOULD emit both adcp_version and adcp_major_version through 3.x to remain compatible with sellers that only read the legacy field. NORMALIZATION: SDKs that read full-semver values from bundle metadata (e.g. ComplianceIndex.published_version = "3.1.0-beta.1") MUST normalize to release-precision ("3.1-beta.1") before emitting on the wire — meta-field values are NOT valid wire values.

    adcp_major_version?: number

    DEPRECATED in favor of adcp_version (release-precision string). Servers MUST continue to honor this field through 3.x. Removed in 4.0. Original semantics: the AdCP major version the buyer's payloads conform to. Sellers validate against their supported major_versions and return VERSION_UNSUPPORTED if unsupported. When omitted, the seller assumes its highest supported version.

    list_id: string

    ID of the property list to update

    account?: AccountReference
    name?: string

    New name for the list

    description?: string

    New description

    base_properties?: BasePropertySource[]

    Complete replacement for the base properties list (not a patch). Each entry is a discriminated union: publisher_tags (publisher_domain + tags), publisher_ids (publisher_domain + property_ids), or identifiers (direct identifiers).

    filters?: PropertyListFilters
    brand?: BrandReference
    webhook_url?: string

    Update the webhook URL for list change notifications (set to empty string to remove)

    context?: ContextObject
    ext?: ExtensionObject
    idempotency_key: string

    Client-generated unique key for at-most-once execution. If a request with the same key has already been processed, the server returns the original response without re-processing. MUST be unique per (seller, request) pair to prevent cross-seller correlation. Use a fresh UUID v4 for each request.

    16

    255

    ^[A-Za-z0-9_.:-]{16,255}$

    Settings

    Member Visibility

    On This Page

    Properties