nodes/generated

Interface HighLevelV2NodeParameters

Source
interface HighLevelV2NodeParameters {
    additionalFields?:
        | {
            address1?: string;
            city?: string;
            customFields?: {
                values: {
                    fieldId: { mode: "id"
                    | "list"; value: string };
                    fieldValue?: string;
                }[];
            };
            dnd?: boolean;
            firstName?: string;
            lastName?: string;
            name?: string;
            notes?: string;
            postalCode?: string;
            source?: string;
            state?: string;
            tags?: string;
            timezone?: { mode: "id"
            | "list"; value: string };
            website?: string;
        }
        | {
            assignedTo?: string;
            companyName?: string;
            monetaryValue?: number;
            stageId?: string;
            tags?: string;
        }
        | { assignedTo?: string; body?: string }
        | {
            address?: string;
            appointmentStatus?:
                | "new"
                | "invalid"
                | "cancelled"
                | "confirmed"
                | "noshow"
                | "showed";
            assignedUserId?: string;
            endTime?: string;
            ignoreDateRange?: boolean;
            title?: string;
            toNotify?: boolean;
        }
        | {
            enableLookBusy?: boolean;
            timezone?: string;
            userId?: string;
            userIds?: { userIds?: string };
        };
    calendarId?: string;
    completed?: boolean;
    contactId?: string;
    dueDate?: string;
    email?: string;
    endDate?: number;
    filters?: | { query?: string }
    | {
        assignedTo?: string;
        campaignId?: string;
        endDate?: string;
        pipelineId?: string;
        query?: string;
        stageId?: string;
        startDate?: string;
        status?: "open" | "won" | "lost" | "abandoned";
    };
    limit?: number;
    locationId?: string;
    name?: string;
    operation?: | "create"
    | "get"
    | "getAll"
    | "update"
    | "delete"
    | "bookAppointment"
    | "getFreeSlots";
    opportunityId?: string;
    options?: {
        order?: "asc"
        | "desc";
        sortBy?: "date_added" | "date_updated";
    };
    phone?: string;
    pipelineId?: string;
    resource?: | "contact"
    | "task"
    | "opportunity"
    | "calendar";
    returnAll?: boolean;
    startDate?: number;
    startTime?: string;
    status?: "open"
    | "won"
    | "lost"
    | "abandoned";
    taskId?: string;
    title?: string;
    updateFields?:
        | {
            address1?: string;
            city?: string;
            customFields?: {
                values: {
                    fieldId: { mode: "id"
                    | "list"; value: string };
                    fieldValue?: string;
                }[];
            };
            dnd?: boolean;
            email?: string;
            firstName?: string;
            lastName?: string;
            name?: string;
            phone?: string;
            postalCode?: string;
            state?: string;
            tags?: string;
            timezone?: { mode: "id"
            | "list"; value: string };
            website?: string;
        }
        | {
            assignedTo?: string;
            monetaryValue?: number;
            name?: string;
            pipelineId?: string;
            stageId?: string;
            status?: "open"
            | "won"
            | "lost"
            | "abandoned";
        }
        | {
            assignedTo?: string;
            body?: string;
            completed?: boolean;
            dueDate?: string;
            title?: string;
        };
}

Properties§

Source§

readonly additionalFields?:
    | {
        address1?: string;
        city?: string;
        customFields?: {
            values: {
                fieldId: { mode: "id"
                | "list"; value: string };
                fieldValue?: string;
            }[];
        };
        dnd?: boolean;
        firstName?: string;
        lastName?: string;
        name?: string;
        notes?: string;
        postalCode?: string;
        source?: string;
        state?: string;
        tags?: string;
        timezone?: { mode: "id"
        | "list"; value: string };
        website?: string;
    }
    | {
        assignedTo?: string;
        companyName?: string;
        monetaryValue?: number;
        stageId?: string;
        tags?: string;
    }
    | { assignedTo?: string; body?: string }
    | {
        address?: string;
        appointmentStatus?:
            | "new"
            | "invalid"
            | "cancelled"
            | "confirmed"
            | "noshow"
            | "showed";
        assignedUserId?: string;
        endTime?: string;
        ignoreDateRange?: boolean;
        title?: string;
        toNotify?: boolean;
    }
    | {
        enableLookBusy?: boolean;
        timezone?: string;
        userId?: string;
        userIds?: { userIds?: string };
    }

Default: {}

Source§

readonly calendarId?: string

Source§

readonly completed?: boolean

Source§

readonly contactId?: string

Source§

readonly dueDate?: string

Source§

readonly email?: string

Email or Phone are required to create contact

Source§

readonly endDate?: number

The end date for fetching free calendar slots. Example: 1601490599999.

Source§

readonly filters?:
    | { query?: string }
    | {
        assignedTo?: string;
        campaignId?: string;
        endDate?: string;
        pipelineId?: string;
        query?: string;
        stageId?: string;
        startDate?: string;
        status?: "open" | "won" | "lost" | "abandoned";
    }

Default: {}

Source§

readonly limit?: number

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

Source§

readonly locationId?: string

Source§

readonly name?: string

Source§

readonly operation?:
    | "create"
    | "get"
    | "getAll"
    | "update"
    | "delete"
    | "bookAppointment"
    | "getFreeSlots"

Default: "create"

Source§

readonly opportunityId?: string

Source§

readonly options?: {
    order?: "asc" | "desc";
    sortBy?: "date_added" | "date_updated";
}

Default: {}

Source§

readonly phone?: string

Phone or Email are required to create contact. Phone number has to start with a valid country code leading with + sign.

Source§

readonly pipelineId?: string

Choose from the list, or specify an ID using an expression Type options: {"loadOptionsMethod":"getPipelines"}

Source§

readonly resource?: "contact" | "task" | "opportunity" | "calendar"

Default: "contact"

Source§

readonly returnAll?: boolean

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

Source§

readonly startDate?: number

The start date for fetching free calendar slots. Example: 1548898600000.

Source§

readonly startTime?: string

Example: 2021-06-23T03:30:00+05:30

Source§

readonly status?: "open" | "won" | "lost" | "abandoned"

Default: "open"

Source§

readonly taskId?: string

Source§

readonly title?: string

Source§

readonly updateFields?:
    | {
        address1?: string;
        city?: string;
        customFields?: {
            values: {
                fieldId: { mode: "id"
                | "list"; value: string };
                fieldValue?: string;
            }[];
        };
        dnd?: boolean;
        email?: string;
        firstName?: string;
        lastName?: string;
        name?: string;
        phone?: string;
        postalCode?: string;
        state?: string;
        tags?: string;
        timezone?: { mode: "id"
        | "list"; value: string };
        website?: string;
    }
    | {
        assignedTo?: string;
        monetaryValue?: number;
        name?: string;
        pipelineId?: string;
        stageId?: string;
        status?: "open"
        | "won"
        | "lost"
        | "abandoned";
    }
    | {
        assignedTo?: string;
        body?: string;
        completed?: boolean;
        dueDate?: string;
        title?: string;
    }

Default: {}