nodes/generated

Interface HighLevelV1NodeParameters

Source
interface HighLevelV1NodeParameters {
    additionalFields?:
        | {
            address1?: string;
            city?: string;
            customFields?: {
                values: { fieldId: string; fieldValue?: string }[];
            };
            dnd?: boolean;
            firstName?: string;
            lastName?: string;
            name?: string;
            postalCode?: string;
            source?: string;
            state?: string;
            tags?: string;
            timezone?: string;
            website?: string;
        }
        | {
            assignedTo?: string;
            companyName?: string;
            monetaryValue?: number;
            name?: string;
            tags?: string;
        }
        | {
            assignedTo?: string;
            description?: string;
            status?: "completed"
            | "incompleted";
        };
    contactId?: string;
    contactIdentifier?: string;
    dueDate?: string;
    email?: string;
    filters?: | { query?: string }
    | {
        assignedTo?: string;
        campaignId?: string;
        endDate?: string;
        query?: string;
        stageId?: string;
        startDate?: string;
        status?: "open" | "won" | "lost" | "abandoned";
    };
    limit?: number;
    operation?: | "create"
    | "get"
    | "getAll"
    | "update"
    | "delete"
    | "lookup";
    opportunityId?: string;
    options?: {
        order?: "asc"
        | "desc";
        sortBy?: "date_added" | "date_updated";
    };
    phone?: string;
    pipelineId?: string;
    resource?: "contact"
    | "task"
    | "opportunity";
    returnAll?: boolean;
    stageId?: string;
    status?: "open" | "won" | "lost" | "abandoned";
    taskId?: string;
    title?: string;
    updateFields?:
        | {
            address1?: string;
            city?: string;
            customFields?: {
                values: { fieldId: string; fieldValue?: string }[];
            };
            dnd?: boolean;
            email?: string;
            firstName?: string;
            lastName?: string;
            name?: string;
            phone?: string;
            postalCode?: string;
            state?: string;
            tags?: string;
            timezone?: string;
            website?: string;
        }
        | {
            assignedTo?: string;
            companyName?: string;
            contactIdentifier?: string;
            monetaryValue?: number;
            name?: string;
            stageId?: string;
            status?: "open"
            | "won"
            | "lost"
            | "abandoned";
            tags?: string;
            title?: string;
        }
        | {
            assignedTo?: string;
            description?: string;
            dueDate?: string;
            status?: "completed"
            | "incompleted";
            title?: string;
        };
}

Properties§

§readonly additionalFields?:
    | {
        address1?: string;
        city?: string;
        customFields?: {
            values: { fieldId: string; fieldValue?: string }[];
        };
        dnd?: boolean;
        firstName?: string;
        lastName?: string;
        name?: string;
        postalCode?: string;
        source?: string;
        state?: string;
        tags?: string;
        timezone?: string;
        website?: string;
    }
    | {
        assignedTo?: string;
        companyName?: string;
        monetaryValue?: number;
        name?: string;
        tags?: string;
    }
    | {
        assignedTo?: string;
        description?: string;
        status?: "completed"
        | "incompleted";
    }

Default: {}

§readonly contactId?: string
§readonly contactIdentifier?: string

Either Email, Phone or Contact ID

§readonly dueDate?: string
§readonly email?: string

Email or Phone are required to create contact

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

Default: {}

§readonly limit?: number

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

§readonly operation?: "create" | "get" | "getAll" | "update" | "delete" | "lookup"

Default: "create"

§readonly opportunityId?: string
§readonly options?: { ... }

Default: {}

§readonly phone?: string

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

§readonly pipelineId?: string

Choose from the list, or specify an ID using an expression Type options: {"loadOptions":{"routing":{"request":{"url":"/pipelines","method":"GET"},"output":{"postReceive":[{"type":"rootProperty","properties":{"property":"pipelines"}},{"type":"setKeyValue","properties":{"name":"={{$responseItem.name}}","value":"={{$responseItem.id}}"}},{"type":"sort","properties":{"key":"name"}}]}}}}

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

Default: "contact"

§readonly returnAll?: boolean

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

§readonly stageId?: string

Choose from the list, or specify an ID using an expression Type options: {"loadOptionsDependsOn":["pipelineId"],"loadOptionsMethod":"getPipelineStages"}

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

Default: "open"

§readonly taskId?: string
§readonly title?: string
§readonly updateFields?:
    | {
        address1?: string;
        city?: string;
        customFields?: {
            values: { fieldId: string; fieldValue?: string }[];
        };
        dnd?: boolean;
        email?: string;
        firstName?: string;
        lastName?: string;
        name?: string;
        phone?: string;
        postalCode?: string;
        state?: string;
        tags?: string;
        timezone?: string;
        website?: string;
    }
    | {
        assignedTo?: string;
        companyName?: string;
        contactIdentifier?: string;
        monetaryValue?: number;
        name?: string;
        stageId?: string;
        status?: "open"
        | "won"
        | "lost"
        | "abandoned";
        tags?: string;
        title?: string;
    }
    | {
        assignedTo?: string;
        description?: string;
        dueDate?: string;
        status?: "completed"
        | "incompleted";
        title?: string;
    }

Default: {}