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

    Interface CreatePropertyListRequest

    Request parameters for creating a new property list

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

    Properties

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

    Properties

    name: string

    Human-readable name for the list

    description?: string

    Description of the list's purpose

    base_properties?: BasePropertySource[]

    Array of property sources to evaluate. Each entry is a discriminated union: publisher_tags (publisher_domain + tags), publisher_ids (publisher_domain + property_ids), or identifiers (direct identifiers). If omitted, queries the agent's entire property database.

    filters?: PropertyListFilters
    brand?: BrandReference
    idempotency_key?: string

    Client-generated unique key for this request. Prevents duplicate property list creation 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