nodes/generated

Interface IntercomNodeParameters

Source
interface IntercomNodeParameters {
    additionalFields?:
        | {
            avatar?: string;
            companies?: unknown[];
            email?: string;
            name?: string;
            phone?: string;
            sessionCount?: number;
            unsubscribedFromEmails?: boolean;
            updateLastRequestAt?: boolean;
            userId?: string;
            utmCampaign?: string;
            utmContent?: string;
            utmMedium?: string;
            utmSource?: string;
            utmTerm?: string;
        }
        | {
            avatar?: string;
            companies?: unknown[];
            email?: string;
            name?: string;
            phone?: string;
            unsubscribedFromEmails?: boolean;
            updateLastRequestAt?: boolean;
            utmCampaign?: string;
            utmContent?: string;
            utmMedium?: string;
            utmSource?: string;
            utmTerm?: string;
        }
        | {
            industry?: string;
            monthlySpend?: string;
            name?: string;
            plan?: string;
            size?: number;
            website?: string;
        };
    companyId?: string;
    customAttributesJson?: string;
    customAttributesUi?: {
        customAttributesValues: {
            name?: string;
            value?: string;
        }[];
    };
    deleteBy?: "id"
    | "userId";
    email?: string;
    filters?:
        | {
            company_id?: string;
            email?: string;
            segment_id?: string;
            tag_id?: string;
        }
        | { email?: string; phone?: string }
        | { segment_id?: string; tag_id?: string };
    id?: string;
    identifierType?: "email" | "userId";
    idValue?: string;
    jsonParameters?: boolean;
    limit?: number;
    listBy?: "id" | "companyId";
    operation?:
        | "create"
        | "get"
        | "getAll"
        | "update"
        | "delete"
        | "users";
    resource?: "company"
    | "user"
    | "lead";
    returnAll?: boolean;
    selectBy?:
        | "id"
        | "email"
        | "name"
        | "phone"
        | "userId"
        | "companyId";
    updateBy?: "id"
    | "email"
    | "userId";
    value?: string;
}

Properties§

§readonly additionalFields?:
    | {
        avatar?: string;
        companies?: unknown[];
        email?: string;
        name?: string;
        phone?: string;
        sessionCount?: number;
        unsubscribedFromEmails?: boolean;
        updateLastRequestAt?: boolean;
        userId?: string;
        utmCampaign?: string;
        utmContent?: string;
        utmMedium?: string;
        utmSource?: string;
        utmTerm?: string;
    }
    | {
        avatar?: string;
        companies?: unknown[];
        email?: string;
        name?: string;
        phone?: string;
        unsubscribedFromEmails?: boolean;
        updateLastRequestAt?: boolean;
        utmCampaign?: string;
        utmContent?: string;
        utmMedium?: string;
        utmSource?: string;
        utmTerm?: string;
    }
    | {
        industry?: string;
        monthlySpend?: string;
        name?: string;
        plan?: string;
        size?: number;
        website?: string;
    }

Default: {}

§readonly companyId?: string

The company ID you have defined for the company

§readonly customAttributesJson?: string

A hash of key/value pairs to represent custom data you want to attribute to a user Type options: {"alwaysOpenEditWindow":true}

§readonly customAttributesUi?: { ... }

A hash of key/value pairs to represent custom data you want to attribute to a user Default: {} Type options: {"multipleValues":true}

§readonly deleteBy?: "id" | "userId"
§readonly email?: string

The email of the user

§readonly filters?:
    | {
        company_id?: string;
        email?: string;
        segment_id?: string;
        tag_id?: string;
    }
    | { email?: string; phone?: string }
    | { segment_id?: string; tag_id?: string }

Default: {}

§readonly id?: string

The Intercom defined ID representing the Lead

§readonly identifierType?: "email" | "userId"

Unique string identifier

§readonly idValue?: string

Unique string identifier value

§readonly jsonParameters?: boolean
§readonly limit?: number

Max number of results to return Default: 50 Type options: {"minValue":1,"maxValue":60}

§readonly listBy?: "id" | "companyId"
§readonly operation?: "create" | "get" | "getAll" | "update" | "delete" | "users"

Default: "create"

§readonly resource?: "company" | "user" | "lead"

Default: "user"

§readonly returnAll?: boolean

Whether to return all results or only up to a given limit

§readonly selectBy?: "id" | "email" | "name" | "phone" | "userId" | "companyId"

The property to select the user by

§readonly updateBy?: "id" | "email" | "userId"

The property via which to query the user Default: "id"

§readonly value?: string

View by value