@adcp/sdk API Reference - v7.9.0
    Preparing search index...

    Interface UpdateCollectionListRequest

    Request parameters for updating an existing collection list

    interface UpdateCollectionListRequest {
        adcp_major_version?: number;
        list_id: string;
        account?: AccountReference;
        name?: string;
        description?: string;
        base_collections?: BaseCollectionSource[];
        filters?: CollectionListFilters;
        brand?: BrandReference;
        webhook_url?: string;
        context?: ContextObject;
        ext?: ExtensionObject;
        idempotency_key: string;
    }
    Index

    Properties

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

    Properties

    adcp_major_version?: number

    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.

    1

    99

    list_id: string

    ID of the collection list to update

    account?: AccountReference
    name?: string

    New name for the list

    description?: string

    New description

    base_collections?: BaseCollectionSource[]

    Complete replacement for the base collections list (not a patch). Each entry is a discriminated union: distribution_ids (platform-independent identifiers), publisher_collections (publisher_domain + collection_ids), or publisher_genres (publisher_domain + genres).

    filters?: CollectionListFilters
    brand?: BrandReference
    webhook_url?: string

    Update the webhook URL for list change notifications (set to empty string to remove). Governance agents MUST validate this URL against SSRF per docs/building/implementation/security#webhook-url-validation-ssrf.

    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