nodes/generated

Interface PipedriveNodeParameters

Source
interface PipedriveNodeParameters {
    activityId?: number;
    additionalFields?:
        | {
            customProperties?: {
                property: { name?: string; value?: string }[];
            };
            deal_id?: number;
            due_date?: string;
            note?: string;
            org_id?: string;
            person_id?: number;
            user_id?: string;
        }
        | {
            currency?: string;
            customProperties?: {
                property: { name?: string; value?: string }[];
            };
            label?: string;
            lost_reason?: string;
            org_id?: number;
            person_id?: number;
            probability?: number;
            stage_id?: string;
            status?: "deleted"
            | "open"
            | "won"
            | "lost";
            user_id?: string;
            value?: number;
            visible_to?: "1" | "3";
        }
        | {
            comments?: string;
            discount_percentage?: number;
            product_variation_id?: string;
        }
        | {
            fields?: ("title" | "notes" | "custom_fields")[];
            includeFields?: string;
            organizationId?: string;
            personId?: string;
            status?: "open" | "won" | "lost";
        }
        | {
            activity_id?: number;
            deal_id?: number;
            org_id?: string;
            person_id?: number;
            product_id?: number;
        }
        | {
            expected_close_date?: string;
            label_ids?: unknown[];
            organization_id?: number;
            owner_id?: string;
            person_id?: number;
            value?: {
                valueProperties: {
                    amount?: number;
                    currency?: | "ALL"
                    | "ARS"
                    | "AUD"
                    | "BRL"
                    | "CAD"
                    | "CHF"
                    | "CNY"
                    | "CZK"
                    | "DKK"
                    | "EUR"
                    | "GBP"
                    | "HKD"
                    | "HUF"
                    | "INR"
                    | "JPY"
                    | "KRW"
                    | "MXN"
                    | "NOK"
                    | "NZD"
                    | "PLN"
                    | "RUB"
                    | "SEK"
                    | "SGD"
                    | "THB"
                    | "TWD"
                    | "USD"
                    | "ZAR"
                    | "AFN"
                    | "DZD"
                    | "AZN"
                    | "BSD"
                    | "BBD"
                    | "BZD"
                    | "BMD"
                    | "BOB"
                    | "BND"
                    | "BGN"
                    | "CLP"
                    | "COP"
                    | "NIO"
                    | "CRC"
                    | "DOP"
                    | "VND"
                    | "XCD"
                    | "EGP"
                    | "FJD"
                    | "UAH"
                    | "JMD"
                    | "KES"
                    | "PGK"
                    | "HRK"
                    | "MMK"
                    | "LAK"
                    | "LBP"
                    | "HNL"
                    | "LRD"
                    | "MYR"
                    | "MUR"
                    | "MAD"
                    | "NPR"
                    | "ILS"
                    | "MRO"
                    | "TOP"
                    | "PKR"
                    | "MOP"
                    | "PHP"
                    | "BWP"
                    | "QAR"
                    | "GTQ"
                    | "RON"
                    | "MVR"
                    | "IDR"
                    | "SAR"
                    | "SCR"
                    | "PEN"
                    | "SBD"
                    | "LKR"
                    | "SYP"
                    | "BDT"
                    | "WST"
                    | "KZT"
                    | "TTD"
                    | "TRY"
                    | "AED"
                    | "VUV"
                    | "XOF"
                    | "YER";
                };
            };
        }
        | {
            customProperties?: {
                property: { name?: string; value?: string }[];
            };
            label?: string;
            visible_to?: "1"
            | "3";
        }
        | {
            exactMatch?: boolean;
            fields?: (
                "address"
                | "name"
                | "notes"
                | "custom_fields"
            )[];
            rawData?: boolean;
        }
        | {
            customProperties?: {
                property: { name?: string; value?: string }[];
            };
            email?: string;
            label?: string;
            marketing_status?: | "subscribed"
            | "unsubscribed"
            | "archived"
            | "no_consent";
            org_id?: string;
            owner_id?: string;
            phone?: string;
            visible_to?: "1"
            | "3";
        }
        | { done?: boolean; exclude?: string }
        | {
            filterId?: string;
            firstChar?: string;
            sort?: string;
        }
        | {
            exactMatch?: boolean;
            fields?: string;
            includeFields?: string;
            organizationId?: string;
            rawData?: boolean;
        }
        | {
            deal_id?: number;
            lead_id?: number;
            org_id?: string;
            person_id?: number;
        }
        | {
            done?: boolean;
            end_date?: string;
            filterId?: string;
            start_date?: string;
            type?: unknown[];
            user_id?: string;
        };
    associateWith?: "person"
    | "organization";
    authentication?: "oAuth2" | "apiToken";
    binaryPropertyName?: string;
    content?: string;
    dealId?: string | number;
    done?: "1" | "0";
    encodeProperties?: boolean;
    exactMatch?: boolean;
    fileId?: number;
    filters?:
        | {
            archived_status?: | "all"
            | "archived"
            | "not_archived";
        }
        | { filterId?: string; firstChar?: string }
        | {
            filter_id?: string;
            stage_id?: string;
            status?:
                | "deleted"
                | "open"
                | "won"
                | "lost"
                | "all_not_deleted";
            user_id?: string;
        };
    item_price?: number;
    leadId?: string;
    limit?: number;
    name?: string;
    noteId?: number;
    operation?: | "create"
    | "get"
    | "getAll"
    | "update"
    | "add"
    | "remove"
    | "delete"
    | "search"
    | "download"
    | "duplicate";
    org_id?: number;
    organization_id?: number;
    organizationId?: number;
    person_id?: number;
    personId?: number;
    productAttachmentId?: string;
    productId?: string;
    quantity?: number;
    resolveProperties?: boolean;
    resource?: | "person"
    | "deal"
    | "organization"
    | "file"
    | "lead"
    | "product"
    | "note"
    | "activity"
    | "dealActivity"
    | "dealProduct";
    returnAll?: boolean;
    subject?: string;
    term?: string;
    title?: string;
    type?: string;
    updateFields?: | {
        busy_flag?: boolean;
        customProperties?: {
            property: { name?: string; value?: string }[];
        };
        deal_id?: number;
        done?: "1"
        | "0";
        due_date?: string;
        note?: string;
        org_id?: string;
        person_id?: number;
        public_description?: string;
        subject?: string;
        type?: string;
        user_id?: string;
    }
    | {
        currency?: string;
        customProperties?: {
            property: { name?: string; value?: string }[];
        };
        label?: string;
        lost_reason?: string;
        org_id?: string;
        person_id?: number;
        probability?: number;
        stage_id?: string;
        status?: "deleted"
        | "open"
        | "won"
        | "lost";
        title?: string;
        user_id?: string;
        value?: number;
        visible_to?: "1" | "3";
    }
    | {
        comments?: string;
        discount_percentage?: number;
        item_price?: number;
        product_variation_id?: string;
        quantity?: number;
    }
    | { description?: string; name?: string }
    | {
        expected_close_date?: string;
        label_ids?: unknown[];
        owner_id?: string;
        person_id?: string;
        title?: string;
        value?: {
            valueProperties: {
                amount?: number;
                currency?:
                    | "ALL"
                    | "ARS"
                    | "AUD"
                    | "BRL"
                    | "CAD"
                    | "CHF"
                    | "CNY"
                    | "CZK"
                    | "DKK"
                    | "EUR"
                    | "GBP"
                    | "HKD"
                    | "HUF"
                    | "INR"
                    | "JPY"
                    | "KRW"
                    | "MXN"
                    | "NOK"
                    | "NZD"
                    | "PLN"
                    | "RUB"
                    | "SEK"
                    | "SGD"
                    | "THB"
                    | "TWD"
                    | "USD"
                    | "ZAR"
                    | "AFN"
                    | "DZD"
                    | "AZN"
                    | "BSD"
                    | "BBD"
                    | "BZD"
                    | "BMD"
                    | "BOB"
                    | "BND"
                    | "BGN"
                    | "CLP"
                    | "COP"
                    | "NIO"
                    | "CRC"
                    | "DOP"
                    | "VND"
                    | "XCD"
                    | "EGP"
                    | "FJD"
                    | "UAH"
                    | "JMD"
                    | "KES"
                    | "PGK"
                    | "HRK"
                    | "MMK"
                    | "LAK"
                    | "LBP"
                    | "HNL"
                    | "LRD"
                    | "MYR"
                    | "MUR"
                    | "MAD"
                    | "NPR"
                    | "ILS"
                    | "MRO"
                    | "TOP"
                    | "PKR"
                    | "MOP"
                    | "PHP"
                    | "BWP"
                    | "QAR"
                    | "GTQ"
                    | "RON"
                    | "MVR"
                    | "IDR"
                    | "SAR"
                    | "SCR"
                    | "PEN"
                    | "SBD"
                    | "LKR"
                    | "SYP"
                    | "BDT"
                    | "WST"
                    | "KZT"
                    | "TTD"
                    | "TRY"
                    | "AED"
                    | "VUV"
                    | "XOF"
                    | "YER";
            };
        };
    }
    | {
        content?: string;
        deal_id?: number;
        lead_id?: number;
        org_id?: string;
        person_id?: number;
    }
    | {
        customProperties?: {
            property: { name?: string; value?: string }[];
        };
        label?: string;
        name?: string;
        owner_id?: number;
        visible_to?: "1"
        | "3";
    }
    | {
        customProperties?: {
            property: { name?: string; value?: string }[];
        };
        email?: string;
        label?: string;
        marketing_status?: | "subscribed"
        | "unsubscribed"
        | "archived"
        | "no_consent";
        name?: string;
        org_id?: string;
        owner_id?: string;
        phone?: string;
        visible_to?: "1"
        | "3";
    };
}

Properties§

§readonly activityId?: number

ID of the activity to delete

§readonly additionalFields?:
    | {
        customProperties?: {
            property: { name?: string; value?: string }[];
        };
        deal_id?: number;
        due_date?: string;
        note?: string;
        org_id?: string;
        person_id?: number;
        user_id?: string;
    }
    | {
        currency?: string;
        customProperties?: {
            property: { name?: string; value?: string }[];
        };
        label?: string;
        lost_reason?: string;
        org_id?: number;
        person_id?: number;
        probability?: number;
        stage_id?: string;
        status?: "deleted"
        | "open"
        | "won"
        | "lost";
        user_id?: string;
        value?: number;
        visible_to?: "1" | "3";
    }
    | {
        comments?: string;
        discount_percentage?: number;
        product_variation_id?: string;
    }
    | {
        fields?: ("title" | "notes" | "custom_fields")[];
        includeFields?: string;
        organizationId?: string;
        personId?: string;
        status?: "open" | "won" | "lost";
    }
    | {
        activity_id?: number;
        deal_id?: number;
        org_id?: string;
        person_id?: number;
        product_id?: number;
    }
    | {
        expected_close_date?: string;
        label_ids?: unknown[];
        organization_id?: number;
        owner_id?: string;
        person_id?: number;
        value?: {
            valueProperties: {
                amount?: number;
                currency?: | "ALL"
                | "ARS"
                | "AUD"
                | "BRL"
                | "CAD"
                | "CHF"
                | "CNY"
                | "CZK"
                | "DKK"
                | "EUR"
                | "GBP"
                | "HKD"
                | "HUF"
                | "INR"
                | "JPY"
                | "KRW"
                | "MXN"
                | "NOK"
                | "NZD"
                | "PLN"
                | "RUB"
                | "SEK"
                | "SGD"
                | "THB"
                | "TWD"
                | "USD"
                | "ZAR"
                | "AFN"
                | "DZD"
                | "AZN"
                | "BSD"
                | "BBD"
                | "BZD"
                | "BMD"
                | "BOB"
                | "BND"
                | "BGN"
                | "CLP"
                | "COP"
                | "NIO"
                | "CRC"
                | "DOP"
                | "VND"
                | "XCD"
                | "EGP"
                | "FJD"
                | "UAH"
                | "JMD"
                | "KES"
                | "PGK"
                | "HRK"
                | "MMK"
                | "LAK"
                | "LBP"
                | "HNL"
                | "LRD"
                | "MYR"
                | "MUR"
                | "MAD"
                | "NPR"
                | "ILS"
                | "MRO"
                | "TOP"
                | "PKR"
                | "MOP"
                | "PHP"
                | "BWP"
                | "QAR"
                | "GTQ"
                | "RON"
                | "MVR"
                | "IDR"
                | "SAR"
                | "SCR"
                | "PEN"
                | "SBD"
                | "LKR"
                | "SYP"
                | "BDT"
                | "WST"
                | "KZT"
                | "TTD"
                | "TRY"
                | "AED"
                | "VUV"
                | "XOF"
                | "YER";
            };
        };
    }
    | {
        customProperties?: {
            property: { name?: string; value?: string }[];
        };
        label?: string;
        visible_to?: "1"
        | "3";
    }
    | {
        exactMatch?: boolean;
        fields?: (
            "address"
            | "name"
            | "notes"
            | "custom_fields"
        )[];
        rawData?: boolean;
    }
    | {
        customProperties?: {
            property: { name?: string; value?: string }[];
        };
        email?: string;
        label?: string;
        marketing_status?: | "subscribed"
        | "unsubscribed"
        | "archived"
        | "no_consent";
        org_id?: string;
        owner_id?: string;
        phone?: string;
        visible_to?: "1"
        | "3";
    }
    | { done?: boolean; exclude?: string }
    | {
        filterId?: string;
        firstChar?: string;
        sort?: string;
    }
    | {
        exactMatch?: boolean;
        fields?: string;
        includeFields?: string;
        organizationId?: string;
        rawData?: boolean;
    }
    | {
        deal_id?: number;
        lead_id?: number;
        org_id?: string;
        person_id?: number;
    }
    | {
        done?: boolean;
        end_date?: string;
        filterId?: string;
        start_date?: string;
        type?: unknown[];
        user_id?: string;
    }

Default: {}

§readonly associateWith?: "person" | "organization"

Type of entity to link to this deal Default: "organization"

§readonly authentication?: "oAuth2" | "apiToken"

Default: "apiToken"

§readonly binaryPropertyName?: string

Default: "data"

§readonly content?: string

The content of the note to create Type options: {"rows":5}

§readonly dealId?: string | number

ID of the deal to delete

§readonly done?: "1" | "0"

Whether the activity is done or not Default: "0"

§readonly encodeProperties?: boolean

By default do custom properties have to be set as ID instead of their actual name. Also option fields have to be set as ID instead of their actual value. If this option gets set they get automatically encoded.

§readonly exactMatch?: boolean

Whether only full exact matches against the given term are returned. It is not case sensitive.

§readonly fileId?: number

ID of the file to delete

§readonly filters?:
    | {
        archived_status?: | "all"
        | "archived"
        | "not_archived";
    }
    | { filterId?: string; firstChar?: string }
    | {
        filter_id?: string;
        stage_id?: string;
        status?:
            | "deleted"
            | "open"
            | "won"
            | "lost"
            | "all_not_deleted";
        user_id?: string;
    }

Default: {}

§readonly item_price?: number

Price at which to add or update this product in a deal Type options: {"numberPrecision":2}

§readonly leadId?: string

ID of the lead to delete

§readonly limit?: number

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

§readonly name?: string

The name of the organization to create

§readonly noteId?: number

ID of the note to delete

§readonly operation?:
    | "create"
    | "get"
    | "getAll"
    | "update"
    | "add"
    | "remove"
    | "delete"
    | "search"
    | "download"
    | "duplicate"

Default: "create"

§readonly org_id?: number

ID of the organization this deal will be associated with

§readonly organization_id?: number

ID of the organization to link to this lead

§readonly organizationId?: number

ID of the organization to delete

§readonly person_id?: number

ID of the person this deal will be associated with

§readonly personId?: number

ID of the person to delete

§readonly productAttachmentId?: string

ID of the deal-product (the ID of the product attached to the deal). Choose from the list, or specify an ID using an expression. Type options: {"loadOptionsMethod":"getProductsDeal","loadOptionsDependsOn":["dealId"]}

§readonly productId?: string

The ID of the product to add to a deal. Choose from the list, or specify an ID using an expression. Type options: {"loadOptionsMethod":"getProducts"}

§readonly quantity?: number

How many items of this product to add/update in a deal Default: 1 Type options: {"minValue":1}

§readonly resolveProperties?: boolean

By default do custom properties get returned only as ID instead of their actual name. Also option fields contain only the ID instead of their actual value. If this option gets set they get automatically resolved.

§readonly resource?:
    | "person"
    | "deal"
    | "organization"
    | "file"
    | "lead"
    | "product"
    | "note"
    | "activity"
    | "dealActivity"
    | "dealProduct"

Default: "deal"

§readonly returnAll?: boolean

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

§readonly subject?: string

The subject of the activity to create

§readonly term?: string

The search term to look for. Minimum 2 characters (or 1 if using exact_match).

§readonly title?: string

The title of the deal to create

§readonly type?: string

Type of the activity like "call", "meeting", etc

§readonly updateFields?:
    | {
        busy_flag?: boolean;
        customProperties?: {
            property: { name?: string; value?: string }[];
        };
        deal_id?: number;
        done?: "1"
        | "0";
        due_date?: string;
        note?: string;
        org_id?: string;
        person_id?: number;
        public_description?: string;
        subject?: string;
        type?: string;
        user_id?: string;
    }
    | {
        currency?: string;
        customProperties?: {
            property: { name?: string; value?: string }[];
        };
        label?: string;
        lost_reason?: string;
        org_id?: string;
        person_id?: number;
        probability?: number;
        stage_id?: string;
        status?: "deleted"
        | "open"
        | "won"
        | "lost";
        title?: string;
        user_id?: string;
        value?: number;
        visible_to?: "1" | "3";
    }
    | {
        comments?: string;
        discount_percentage?: number;
        item_price?: number;
        product_variation_id?: string;
        quantity?: number;
    }
    | { description?: string; name?: string }
    | {
        expected_close_date?: string;
        label_ids?: unknown[];
        owner_id?: string;
        person_id?: string;
        title?: string;
        value?: {
            valueProperties: {
                amount?: number;
                currency?:
                    | "ALL"
                    | "ARS"
                    | "AUD"
                    | "BRL"
                    | "CAD"
                    | "CHF"
                    | "CNY"
                    | "CZK"
                    | "DKK"
                    | "EUR"
                    | "GBP"
                    | "HKD"
                    | "HUF"
                    | "INR"
                    | "JPY"
                    | "KRW"
                    | "MXN"
                    | "NOK"
                    | "NZD"
                    | "PLN"
                    | "RUB"
                    | "SEK"
                    | "SGD"
                    | "THB"
                    | "TWD"
                    | "USD"
                    | "ZAR"
                    | "AFN"
                    | "DZD"
                    | "AZN"
                    | "BSD"
                    | "BBD"
                    | "BZD"
                    | "BMD"
                    | "BOB"
                    | "BND"
                    | "BGN"
                    | "CLP"
                    | "COP"
                    | "NIO"
                    | "CRC"
                    | "DOP"
                    | "VND"
                    | "XCD"
                    | "EGP"
                    | "FJD"
                    | "UAH"
                    | "JMD"
                    | "KES"
                    | "PGK"
                    | "HRK"
                    | "MMK"
                    | "LAK"
                    | "LBP"
                    | "HNL"
                    | "LRD"
                    | "MYR"
                    | "MUR"
                    | "MAD"
                    | "NPR"
                    | "ILS"
                    | "MRO"
                    | "TOP"
                    | "PKR"
                    | "MOP"
                    | "PHP"
                    | "BWP"
                    | "QAR"
                    | "GTQ"
                    | "RON"
                    | "MVR"
                    | "IDR"
                    | "SAR"
                    | "SCR"
                    | "PEN"
                    | "SBD"
                    | "LKR"
                    | "SYP"
                    | "BDT"
                    | "WST"
                    | "KZT"
                    | "TTD"
                    | "TRY"
                    | "AED"
                    | "VUV"
                    | "XOF"
                    | "YER";
            };
        };
    }
    | {
        content?: string;
        deal_id?: number;
        lead_id?: number;
        org_id?: string;
        person_id?: number;
    }
    | {
        customProperties?: {
            property: { name?: string; value?: string }[];
        };
        label?: string;
        name?: string;
        owner_id?: number;
        visible_to?: "1"
        | "3";
    }
    | {
        customProperties?: {
            property: { name?: string; value?: string }[];
        };
        email?: string;
        label?: string;
        marketing_status?: | "subscribed"
        | "unsubscribed"
        | "archived"
        | "no_consent";
        name?: string;
        org_id?: string;
        owner_id?: string;
        phone?: string;
        visible_to?: "1"
        | "3";
    }

Default: {}