kustomer-client
    Preparing search index...

    Type Alias BulkBatchUpdateCustomersData

    type BulkBatchUpdateCustomersData = {
        body?: {
            avatarUrl?: string | null;
            birthdayAt?: string | null;
            company?: string | null;
            createdAt?: string;
            custom?: { [key: string]: never };
            defaultLang?: string | null;
            emails?: {
                email: string;
                type?: "home" | "work" | "other";
                verified?: boolean;
            }[];
            externalId?: string
            | null;
            externalIds?: { externalId: string; verified?: boolean }[];
            facebookIds?: { name?: string; pageId: string; userId: string }[];
            gender?: "m" | "f";
            id: string;
            importedAt?: string;
            lastActivityAt?: string | null;
            lastCustomerActivityAt?: string | null;
            lastSeenAt?: string | null;
            locale?: string | null;
            locations?: {
                address?: string | null;
                address2?: string | null;
                address3?: string | null;
                areaCode?: string | null;
                cityName?: string | null;
                countryCode?: string | null;
                countryName?: string | null;
                latitude?: number | null;
                longitude?: number | null;
                name?: string | null;
                regionCode?: string | null;
                regionName?: string | null;
                type?: "home" | "work" | "other";
                zipCode?: string | null;
            }[];
            name?: string
            | null;
            phones?: {
                phone: string;
                type?: "mobile" | "home" | "work" | "fax" | "other";
                verified?: boolean;
            }[];
            rev?: number;
            sentiment?: { confidence: number; polarity: -1
            | 0
            | 1 };
            sharedEmails?: {
                email: string;
                type?: "home" | "work" | "other";
                verified?: boolean;
            }[];
            sharedExternalIds?: { externalId: string; verified?: boolean }[];
            sharedPhones?: {
                phone: string;
                type?: "mobile" | "home" | "work" | "fax" | "other";
                verified?: boolean;
            }[];
            sharedSocials?: {
                type: "twitter"
                | "facebook"
                | "instagram"
                | "linkedin"
                | "pinterest";
                url?: string;
                userid?: string;
                username: string;
                verified?: boolean;
            }[];
            signedUpAt?: string
            | null;
            socials?: {
                type: "twitter" | "facebook" | "instagram" | "linkedin" | "pinterest";
                url?: string;
                userid?: string;
                username: string;
                verified?: boolean;
            }[];
            tags?: string[];
            timeZone?: string
            | null;
            urls?: { type?: "website" | "blog" | "other"; url: string }[];
            username?: string | null;
        }[];
        path?: never;
        query?: { ids?: string };
        url: "/customers/bulk";
    }
    Index

    Properties

    Properties

    body?: {
        avatarUrl?: string | null;
        birthdayAt?: string | null;
        company?: string | null;
        createdAt?: string;
        custom?: { [key: string]: never };
        defaultLang?: string | null;
        emails?: {
            email: string;
            type?: "home" | "work" | "other";
            verified?: boolean;
        }[];
        externalId?: string
        | null;
        externalIds?: { externalId: string; verified?: boolean }[];
        facebookIds?: { name?: string; pageId: string; userId: string }[];
        gender?: "m" | "f";
        id: string;
        importedAt?: string;
        lastActivityAt?: string | null;
        lastCustomerActivityAt?: string | null;
        lastSeenAt?: string | null;
        locale?: string | null;
        locations?: {
            address?: string | null;
            address2?: string | null;
            address3?: string | null;
            areaCode?: string | null;
            cityName?: string | null;
            countryCode?: string | null;
            countryName?: string | null;
            latitude?: number | null;
            longitude?: number | null;
            name?: string | null;
            regionCode?: string | null;
            regionName?: string | null;
            type?: "home" | "work" | "other";
            zipCode?: string | null;
        }[];
        name?: string
        | null;
        phones?: {
            phone: string;
            type?: "mobile" | "home" | "work" | "fax" | "other";
            verified?: boolean;
        }[];
        rev?: number;
        sentiment?: { confidence: number; polarity: -1
        | 0
        | 1 };
        sharedEmails?: {
            email: string;
            type?: "home" | "work" | "other";
            verified?: boolean;
        }[];
        sharedExternalIds?: { externalId: string; verified?: boolean }[];
        sharedPhones?: {
            phone: string;
            type?: "mobile" | "home" | "work" | "fax" | "other";
            verified?: boolean;
        }[];
        sharedSocials?: {
            type: "twitter"
            | "facebook"
            | "instagram"
            | "linkedin"
            | "pinterest";
            url?: string;
            userid?: string;
            username: string;
            verified?: boolean;
        }[];
        signedUpAt?: string
        | null;
        socials?: {
            type: "twitter" | "facebook" | "instagram" | "linkedin" | "pinterest";
            url?: string;
            userid?: string;
            username: string;
            verified?: boolean;
        }[];
        tags?: string[];
        timeZone?: string
        | null;
        urls?: { type?: "website" | "blog" | "other"; url: string }[];
        username?: string | null;
    }[]
    path?: never
    query?: { ids?: string }

    Type declaration

    • Optionalids?: string

      Comma-separated list of unique customer IDs.

    url: "/customers/bulk"