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

    Interface UpdatePropertyListRequest

    Request parameters for updating an existing property list

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

    Properties

    list_id name? description? base_properties? filters? brand? webhook_url? context? ext? idempotency_key?

    Properties

    list_id: string

    ID of the property list to update

    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.

    Settings

    Member Visibility

    On This Page

    Properties