interface PipedriveV2NodeParameters {
activityId?: number;
additionalFields?:
| {
customFields?: {
property: { name?: string; value?: string }[];
};
deal_id?: number;
due_date?: string;
note?: string;
org_id?: string;
person_id?: number;
user_id?: string;
}
| {
currency?: string;
customFields?: {
property: { name?: string; value?: string }[];
};
expected_close_date?: string;
label_ids?: unknown[];
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";
}
| {
fields?: ("title" | "notes" | "custom_fields")[];
includeFields?: string;
organizationId?: string;
personId?: string;
status?: "open" | "won" | "lost";
}
| {
comments?: string;
discount?: number;
discount_type?: "percentage"
| "amount";
tax?: number;
}
| {
activity_id?: number;
deal_id?: number;
lead_id?: string;
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";
};
};
visible_to?: "1"
| "3";
was_seen?: boolean;
}
| {
deal_id?: number;
lead_id?: string;
org_id?: string;
person_id?: number;
pinned_to_deal_flag?: boolean;
pinned_to_organization_flag?: boolean;
pinned_to_person_flag?: boolean;
}
| {
customFields?: {
property: { name?: string; value?: string }[];
};
label_ids?: unknown[];
owner_id?: string;
visible_to?: "1"
| "3";
}
| {
fields?: (
"address"
| "name"
| "notes"
| "custom_fields"
)[];
}
| {
customFields?: {
property: { name?: string; value?: string }[];
};
emails?: {
emailProperties: {
label?: "home"
| "work"
| "other";
primary?: boolean;
value?: string;
}[];
};
label_ids?: unknown[];
org_id?: string;
owner_id?: string;
phones?: {
phoneProperties: {
label?: "home"
| "work"
| "mobile"
| "other";
primary?: boolean;
value?: string;
}[];
};
visible_to?: "1"
| "3";
}
| {
fields?: (
| "email"
| "name"
| "phone"
| "notes"
| "custom_fields"
)[];
includeFields?: string;
organizationId?: string;
}
| {
code?: string;
customFields?: {
property: { name?: string; value?: string }[];
};
owner_id?: number;
prices?: {
pricesValues: {
cost?: number;
currency?: string;
price?: number;
}[];
};
tax?: number;
unit?: string;
visible_to?: "1"
| "3";
}
| {
fields?: ("name" | "code" | "custom_fields")[];
includeFields?: string;
};
associateWith?: "person"
| "organization";
authentication?: "oAuth2" | "apiToken";
binaryPropertyName?: string;
content?: string;
dealId?: number;
done?: boolean;
exactMatch?: boolean;
fileId?: number;
filters?:
| {
dealId?: number;
done?: boolean;
end_date?: string;
filterId?: string;
start_date?: string;
type?: unknown[];
user_id?: string;
}
| {
filter_id?: string;
stage_id?: string;
status?: | "deleted"
| "open"
| "won"
| "lost"
| "all_not_deleted";
user_id?: string;
}
| {
archived_status?: | "all"
| "archived"
| "not_archived";
organization_id?: number;
owner_id?: string;
person_id?: number;
}
| {
deal_id?: number;
end_date?: string;
lead_id?: string;
org_id?: string;
person_id?: number;
pinned_to_deal_flag?: boolean;
pinned_to_organization_flag?: boolean;
pinned_to_person_flag?: boolean;
sort?: "id"
| "content"
| "update_time";
start_date?: string;
}
| { filter_id?: string; first_char?: 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?: number;
productId?: number;
quantity?: number;
rawCustomFieldKeys?: boolean;
rawCustomFieldOutput?: boolean;
resource?: | "person"
| "deal"
| "organization"
| "file"
| "lead"
| "product"
| "note"
| "activity"
| "dealProduct";
returnAll?: boolean;
subject?: string;
term?: string;
title?: string;
type?: string;
updateFields?: | {
busy_flag?: boolean;
customFields?: {
property: { name?: string; value?: string }[];
};
deal_id?: number;
done?: boolean;
due_date?: string;
note?: string;
org_id?: string;
person_id?: number;
public_description?: string;
subject?: string;
type?: string;
user_id?: string;
}
| {
currency?: string;
customFields?: {
property: { name?: string; value?: string }[];
};
expected_close_date?: string;
label_ids?: unknown[];
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?: number;
discount_type?: "percentage"
| "amount";
item_price?: number;
quantity?: number;
tax?: number;
}
| { description?: string; name?: string }
| {
expected_close_date?: string;
is_archived?: boolean;
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";
};
};
visible_to?: "1"
| "3";
was_seen?: boolean;
}
| {
content?: string;
deal_id?: number;
lead_id?: string;
org_id?: string;
person_id?: number;
pinned_to_deal_flag?: boolean;
pinned_to_organization_flag?: boolean;
pinned_to_person_flag?: boolean;
}
| {
customFields?: {
property: { name?: string; value?: string }[];
};
label_ids?: unknown[];
name?: string;
owner_id?: string;
visible_to?: "1"
| "3";
}
| {
customFields?: {
property: { name?: string; value?: string }[];
};
emails?: {
emailProperties: {
label?: "home"
| "work"
| "other";
primary?: boolean;
value?: string;
}[];
};
label_ids?: unknown[];
name?: string;
org_id?: string;
owner_id?: string;
phones?: {
phoneProperties: {
label?: "home"
| "work"
| "mobile"
| "other";
primary?: boolean;
value?: string;
}[];
};
visible_to?: "1"
| "3";
}
| {
code?: string;
customFields?: {
property: { name?: string; value?: string }[];
};
name?: string;
owner_id?: number;
prices?: {
pricesValues: {
cost?: number;
currency?: string;
price?: number;
}[];
};
tax?: number;
unit?: string;
visible_to?: "1"
| "3";
};
}Properties§
§§§§§§§§§§§§§§§§§§§§§§§§§§§§§§§§§
readonly activity§
readonly additional
| {
customFields?: {
property: { name?: string; value?: string }[];
};
deal_id?: number;
due_date?: string;
note?: string;
org_id?: string;
person_id?: number;
user_id?: string;
}
| {
currency?: string;
customFields?: {
property: { name?: string; value?: string }[];
};
expected_close_date?: string;
label_ids?: unknown[];
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";
}
| {
fields?: ("title" | "notes" | "custom_fields")[];
includeFields?: string;
organizationId?: string;
personId?: string;
status?: "open" | "won" | "lost";
}
| {
comments?: string;
discount?: number;
discount_type?: "percentage"
| "amount";
tax?: number;
}
| {
activity_id?: number;
deal_id?: number;
lead_id?: string;
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";
};
};
visible_to?: "1"
| "3";
was_seen?: boolean;
}
| {
deal_id?: number;
lead_id?: string;
org_id?: string;
person_id?: number;
pinned_to_deal_flag?: boolean;
pinned_to_organization_flag?: boolean;
pinned_to_person_flag?: boolean;
}
| {
customFields?: {
property: { name?: string; value?: string }[];
};
label_ids?: unknown[];
owner_id?: string;
visible_to?: "1"
| "3";
}
| {
fields?: (
"address"
| "name"
| "notes"
| "custom_fields"
)[];
}
| {
customFields?: {
property: { name?: string; value?: string }[];
};
emails?: {
emailProperties: {
label?: "home"
| "work"
| "other";
primary?: boolean;
value?: string;
}[];
};
label_ids?: unknown[];
org_id?: string;
owner_id?: string;
phones?: {
phoneProperties: {
label?: "home"
| "work"
| "mobile"
| "other";
primary?: boolean;
value?: string;
}[];
};
visible_to?: "1"
| "3";
}
| {
fields?: (
| "email"
| "name"
| "phone"
| "notes"
| "custom_fields"
)[];
includeFields?: string;
organizationId?: string;
}
| {
code?: string;
customFields?: {
property: { name?: string; value?: string }[];
};
owner_id?: number;
prices?: {
pricesValues: {
cost?: number;
currency?: string;
price?: number;
}[];
};
tax?: number;
unit?: string;
visible_to?: "1"
| "3";
}
| {
fields?: ("name" | "code" | "custom_fields")[];
includeFields?: string;
}Default: {}
readonly associateType of entity to link to this deal Default: "organization"
readonly authentication?: "oAuth2" | "apiToken"Default: "apiToken"
readonly binaryDefault: "data"
readonly content?: stringThe content of the note to create Type options: {"rows":5}
readonly dealID of the deal to delete
readonly done?: booleanWhether the activity is done or not
readonly exactWhether only full exact matches against the given term are returned. It is not case sensitive.
readonly fileID of the file to delete
readonly filters?:
| {
dealId?: number;
done?: boolean;
end_date?: string;
filterId?: string;
start_date?: string;
type?: unknown[];
user_id?: string;
}
| {
filter_id?: string;
stage_id?: string;
status?: | "deleted"
| "open"
| "won"
| "lost"
| "all_not_deleted";
user_id?: string;
}
| {
archived_status?: | "all"
| "archived"
| "not_archived";
organization_id?: number;
owner_id?: string;
person_id?: number;
}
| {
deal_id?: number;
end_date?: string;
lead_id?: string;
org_id?: string;
person_id?: number;
pinned_to_deal_flag?: boolean;
pinned_to_organization_flag?: boolean;
pinned_to_person_flag?: boolean;
sort?: "id"
| "content"
| "update_time";
start_date?: string;
}
| { filter_id?: string; first_char?: string }Default: {}
readonly itemPrice at which to add this product to the deal Type options: {"numberPrecision":2}
readonly leadID of the lead to delete
readonly limit?: numberMax number of results to return Default: 100 Type options: {"minValue":1,"maxValue":500}
readonly name?: stringThe name of the organization to create
readonly noteID of the note to delete
readonly operation?:
| "create"
| "get"
| "getAll"
| "update"
| "add"
| "remove"
| "delete"
| "search"
| "download"
| "duplicate"Default: "create"
readonly orgID of the organization this deal will be associated with
readonly organizationID of the organization to link to this lead
readonly organizationID of the organization to delete
readonly personID of the person this deal will be associated with
readonly personID of the person to delete
readonly productID of the deal-product (the ID of the product attached to the deal, not the product ID itself)
readonly productID of the product to add to the deal
readonly quantity?: numberHow many items of this product to add to the deal Default: 1 Type options: {"minValue":1}
readonly rawWhether to provide raw Pipedrive field keys and option IDs instead of human-readable names
readonly rawWhether to show raw Pipedrive field keys and option IDs instead of human-readable names in output
readonly resource?:
| "person"
| "deal"
| "organization"
| "file"
| "lead"
| "product"
| "note"
| "activity"
| "dealProduct"Default: "deal"
readonly returnWhether to return all results or only up to a given limit
readonly subject?: stringThe subject of the activity to create
readonly term?: stringThe search term to look for. Minimum 2 characters (or 1 if using exact_match).
readonly title?: stringThe title of the deal to create
readonly type?: stringType of the activity like "call", "meeting", etc
readonly update
| {
busy_flag?: boolean;
customFields?: {
property: { name?: string; value?: string }[];
};
deal_id?: number;
done?: boolean;
due_date?: string;
note?: string;
org_id?: string;
person_id?: number;
public_description?: string;
subject?: string;
type?: string;
user_id?: string;
}
| {
currency?: string;
customFields?: {
property: { name?: string; value?: string }[];
};
expected_close_date?: string;
label_ids?: unknown[];
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?: number;
discount_type?: "percentage"
| "amount";
item_price?: number;
quantity?: number;
tax?: number;
}
| { description?: string; name?: string }
| {
expected_close_date?: string;
is_archived?: boolean;
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";
};
};
visible_to?: "1"
| "3";
was_seen?: boolean;
}
| {
content?: string;
deal_id?: number;
lead_id?: string;
org_id?: string;
person_id?: number;
pinned_to_deal_flag?: boolean;
pinned_to_organization_flag?: boolean;
pinned_to_person_flag?: boolean;
}
| {
customFields?: {
property: { name?: string; value?: string }[];
};
label_ids?: unknown[];
name?: string;
owner_id?: string;
visible_to?: "1"
| "3";
}
| {
customFields?: {
property: { name?: string; value?: string }[];
};
emails?: {
emailProperties: {
label?: "home"
| "work"
| "other";
primary?: boolean;
value?: string;
}[];
};
label_ids?: unknown[];
name?: string;
org_id?: string;
owner_id?: string;
phones?: {
phoneProperties: {
label?: "home"
| "work"
| "mobile"
| "other";
primary?: boolean;
value?: string;
}[];
};
visible_to?: "1"
| "3";
}
| {
code?: string;
customFields?: {
property: { name?: string; value?: string }[];
};
name?: string;
owner_id?: number;
prices?: {
pricesValues: {
cost?: number;
currency?: string;
price?: number;
}[];
};
tax?: number;
unit?: string;
visible_to?: "1"
| "3";
}Default: {}
ID of the activity to delete