Module pipedrive

ballerinax/pipedrive Ballerina library

1.5.1

Overview

This is a generated connector for Pipedrive API v1 OpenAPI specification. Pipedrive is a sales CRM and pipeline management solution that enables businesses to plan their sales activities and monitor deals. Built using activity-based selling methodology, Pipedrive streamlines every action involved in converting a potential deal into a successful sale.

Prerequisites

Before using this connector in your Ballerina application, complete the following:

Create a Pipedrive developer account
Obtain tokens by following this guide

Quickstart

To use the Pipedrive connector in your Ballerina application, update the .bal file as follows:

Step 1: Import connector

First, import the ballerinax/pipedrive module into the Ballerina project.


import ballerinax/pipedrive;

Step 2: Create a new connector instance

Create a pipedrive:ApiKeysConfig with the API key obtained, and initialize the connector with it.


pipedrive:ApiKeysConfig config = {
    apiToken: "<API_KEY>"
}
pipedrive:Client baseClient = check new Client(config);

Step 3: Invoke connector operation

Now you can use the operations available within the connector. Note that they are in the form of remote operations.

Following is an example on how to get all Activities assigned to a particular user using the connector.

Returns all Activities assigned to a particular User


public function main() {
    pipedrive:GetActivitiesResponse200|error response = baseClient->getActivities();
    if (response is pipedrive:GetActivitiesResponse200) {
        log:printInfo(response.toString());
    } else {
        log:printError(response.message());
    }
}

Use bal run command to compile and run the Ballerina program.

Clients

pipedrive: Client

Isolated

Constructor

Gets invoked to initialize the connector. The connector initialization requires setting the API credentials. Create a Pipedrive account and obtain tokens by following this guide.

init (ApiKeysConfig apiKeyConfig, ConnectionConfig config, string serviceUrl)

apiKeyConfig ApiKeysConfig - API keys for authorization

config ConnectionConfig {} - The configurations to be used when initializing the connector

serviceUrl string "https://api.pipedrive.com/v1" - URL of the target service

getActivities

Isolated FunctionRemote Function

function getActivities(int? userId, int? filterId, string? 'type, int? 'limit, int? 'start, string? startDate, string? endDate, decimal? done) returns GetActivitiesResponse200|error

Get all Activities assigned to a particular User

Parameters

userId int? (default ()) - The ID of the User whose Activities will be fetched. If omitted, the User associated with the API token will be used. If 0, Activities for all company Users will be fetched based on the permission sets.

filterId int? (default ()) - The ID of the Filter to use (will narrow down results if used together with user_id parameter)

'type string? (default ()) - Type of the Activity, can be one type or multiple types separated by a comma. This is in correlation with the key_string parameter of ActivityTypes.

'limit int? (default ()) - For pagination, the limit of entries to be returned. If not provided, 100 items will be returned.

'start int? (default ()) - For pagination, the position that represents the first result for the page

startDate string? (default ()) - Use the Activity due date where you wish to begin fetching Activities from. Insert due date in YYYY-MM-DD format.

endDate string? (default ()) - Use the Activity due date where you wish to stop fetching Activities from. Insert due date in YYYY-MM-DD format.

done decimal? (default ()) - Whether the Activity is done or not. 0 = Not done, 1 = Done. If omitted returns both Done and Not done activities.

Return Type

GetActivitiesResponse200|error - A list of Activities

addActivity

Isolated FunctionRemote Function

function addActivity(AddActivityRequest payload) returns AddActivityResponse200|error

Add an Activity

Parameters

payload AddActivityRequest - AddActivity request

Return Type

AddActivityResponse200|error - The Activity was successfully added

deleteActivities

Isolated FunctionRemote Function

function deleteActivities(string ids) returns DeleteActivitiesResponse200|error

Delete multiple Activities in bulk

Parameters

ids string - Comma-separated IDs of Activities that will be deleted

Return Type

DeleteActivitiesResponse200|error - The Activities were successfully deleted

getActivity

Isolated FunctionRemote Function

function getActivity(int id) returns GetActivityResponse200|error

Get details of an Activity

Parameters

id int - The ID of the Activity

Return Type

GetActivityResponse200|error - The request was successful

updateActivity

Isolated FunctionRemote Function

function updateActivity(int id, UpdateActivityRequest payload) returns UpdateActivityResponse200|error

Edit an Activity

Parameters

id int - The ID of the Activity

payload UpdateActivityRequest - UpdateActivity request

Return Type

UpdateActivityResponse200|error - The request was successful

deleteActivity

Isolated FunctionRemote Function

function deleteActivity(int id) returns DeleteActivityResponse200|error

Delete an Activity

Parameters

id int - The ID of the Activity

Return Type

DeleteActivityResponse200|error - The Activity was successfully deleted

getActivityFields

Isolated FunctionRemote Function

function getActivityFields() returns FieldsResponse200|error

Get all activity fields

Return Type

FieldsResponse200|error - success

getActivityTypes

Isolated FunctionRemote Function

function getActivityTypes() returns GetActivityTypesResponse200|error

Get all ActivityTypes

Return Type

GetActivityTypesResponse200|error - A list of ActivityTypes

addActivityType

Isolated FunctionRemote Function

function addActivityType(AddActivityTypeRequest payload) returns CreateUpdateDeleteActivityTypeResponse200|error

Add new ActivityType

Parameters

payload AddActivityTypeRequest - AddActivityType request

Return Type

CreateUpdateDeleteActivityTypeResponse200|error - The ActivityType was successfully created

deleteActivityTypes

Isolated FunctionRemote Function

function deleteActivityTypes(string ids) returns DeleteActivityTypesResponse200|error

Delete multiple ActivityTypes in bulk

Parameters

ids string - Comma-separated ActivityType IDs

Return Type

DeleteActivityTypesResponse200|error - The ActivityTypes were successfully deleted

updateActivityType

Isolated FunctionRemote Function

function updateActivityType(int id, UpdateActivityTypeRequest payload) returns CreateUpdateDeleteActivityTypeResponse200|error

Edit an ActivityType

Parameters

id int - The ID of the ActivityType

payload UpdateActivityTypeRequest - UpdateActivityType request

Return Type

CreateUpdateDeleteActivityTypeResponse200|error - The ActivityType was successfully updated

deleteActivityType

Isolated FunctionRemote Function

function deleteActivityType(int id) returns CreateUpdateDeleteActivityTypeResponse200|error

Delete an ActivityType

Parameters

id int - The ID of the ActivityType

Return Type

CreateUpdateDeleteActivityTypeResponse200|error - The ActivityType was successfully deleted

getUserCallLogs

Isolated FunctionRemote Function

function getUserCallLogs(decimal? 'limit, decimal? 'start) returns GetUserCallLogsResponse200|error

Get all call logs assigned to a particular user

Parameters

'limit decimal? (default ()) - For pagination, the limit of entries to be returned

'start decimal? (default ()) - For pagination, the position that represents the first result for the page

Return Type

GetUserCallLogsResponse200|error - A list of call logs.

addCallLog

Isolated FunctionRemote Function

function addCallLog(AddCallLogRequest payload) returns AddCallLogResponse200|error

Add a call log

Parameters

payload AddCallLogRequest - AddCallLog request

Return Type

AddCallLogResponse200|error - The call log was successfully created.

getCallLog

Isolated FunctionRemote Function

function getCallLog(string id) returns InlineResponse200|error

Get details of a call log

Parameters

id string - The ID received when you create the call log

Return Type

InlineResponse200|error - The requested call log object.

deleteCallLog

Isolated FunctionRemote Function

function deleteCallLog(string id) returns DeleteCallLogResponse200|error

Delete a call log

Parameters

id string - The ID received when you create the call log

Return Type

DeleteCallLogResponse200|error - The call log was successfully deleted.

getCurrencies

Isolated FunctionRemote Function

function getCurrencies(string? term) returns GetCurrenciesResponse200|error

Get all supported currencies

Parameters

term string? (default ()) - Optional search term that is searched for from currency's name and/or code.

Return Type

GetCurrenciesResponse200|error - The list of supported currencies

getDeals

Isolated FunctionRemote Function

function getDeals(int? userId, int? filterId, int? stageId, string status, int 'start, int? 'limit, string? sort, decimal? ownedByYou) returns GetDealsResponse200|error

Get all deals

Parameters

userId int? (default ()) - If supplied, only deals matching the given user will be returned. However, filter_id and owned_by_you takes precedence over user_id when supplied.

filterId int? (default ()) - ID of the filter to use

stageId int? (default ()) - If supplied, only deals within the given stage will be returned.

status string (default "all_not_deleted") - Only fetch deals with specific status. If omitted, all not deleted deals are fetched.

'start int (default 0) - Pagination start

'limit int? (default ()) - Items shown per page

sort string? (default ()) - Field names and sorting mode separated by a comma (field_name_1 ASC, field_name_2 DESC). Only first-level field keys are supported (no nested keys).

ownedByYou decimal? (default ()) - When supplied, only deals owned by you are returned. However, filter_id takes precedence over owned_by_you when both are supplied.

Return Type

GetDealsResponse200|error - Get all Deals

addDeal

Isolated FunctionRemote Function

function addDeal(AddDealRequest payload) returns DealResponse200|error

Add a deal

Parameters

payload AddDealRequest - AddDeal request

Return Type

DealResponse200|error - Add a Deal

deleteDeals

Isolated FunctionRemote Function

function deleteDeals(string ids) returns DeleteDealsResponse200|error

Delete multiple deals in bulk

Parameters

ids string - Comma-separated IDs that will be deleted

Return Type

DeleteDealsResponse200|error - Delete multiple deals in bulk

searchDeals

Isolated FunctionRemote Function

function searchDeals(string term, string? fields, boolean? exactMatch, int? personId, int? organizationId, string? status, string? includeFields, int 'start, int? 'limit) returns SearchDealsResponse200|error

Search deals

Parameters

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

fields string? (default ()) - A comma-separated string array. The fields to perform the search from. Defaults to all of them.

exactMatch boolean? (default ()) - When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.

personId int? (default ()) - Will filter Deals by the provided Person ID. The upper limit of found Deals associated with the Person is 2000.

organizationId int? (default ()) - Will filter Deals by the provided Organization ID. The upper limit of found Deals associated with the Organization is 2000.

status string? (default ()) - Will filter Deals by the provided specific status. open = Open, won = Won, lost = Lost. The upper limit of found Deals associated with the status is 2000.

includeFields string? (default ()) - Supports including optional fields in the results which are not provided by default.

'start int (default 0) - Pagination start. Note that the pagination is based on main results and does not include related items when using search_for_related_items parameter.

'limit int? (default ()) - Items shown per page

Return Type

SearchDealsResponse200|error - success

getDealsByName

DeprecatedIsolated FunctionRemote Function

function getDealsByName(string term, int? personId, int? orgId) returns GetDealsByNameResponse200|error

Find deals by name

Parameters

term string - Search term to look for

personId int? (default ()) - ID of the person the Deal is associated with.

orgId int? (default ()) - ID of the organization the Deal is associated with.

Return Type

GetDealsByNameResponse200|error - Get Deals by name
Deprecated

getDealsSummary

Isolated FunctionRemote Function

function getDealsSummary(string? status, int? filterId, int? userId, int? stageId) returns GetDealsSummaryResponse200|error

Get deals summary

Parameters

status string? (default ()) - Only fetch deals with specific status. open = Open, won = Won, lost = Lost

filterId int? (default ()) - <code>user_id</code> will not be considered. Only deals matching the given filter will be returned.

userId int? (default ()) - Only deals matching the given user will be returned. user_id will not be considered if you use filter_id.

stageId int? (default ()) - Only deals within the given stage will be returned.

Return Type

GetDealsSummaryResponse200|error - Get the summary of the Deals

getDealsTimeline

Isolated FunctionRemote Function

function getDealsTimeline(string startDate, string interval, int amount, string fieldKey, int? userId, int? pipelineId, int? filterId, decimal? excludeDeals, string? totalsConvertCurrency) returns GetDealsTimelineResponse200|error

Get deals timeline

Parameters

startDate string - Date where the first interval starts. Format: YYYY-MM-DD

interval string - The type of interval<table><tr><th>Value</th><th>Description</th></tr><tr><td>day</td><td>Day</td></tr><tr><td>week</td><td>A full week (7 days) starting from start_date</td></tr><tr><td>month</td><td>A full month (depending on the number of days in given month) starting from start_date</td></tr><tr><td>quarter</td><td>A full quarter (3 months) starting from start_date</td></tr></table>

amount int - The number of given intervals, starting from start_date, to fetch. E.g. 3 (months).

fieldKey string - The date field key which deals will be retrieved from

userId int? (default ()) - If supplied, only deals matching the given user will be returned.

pipelineId int? (default ()) - If supplied, only deals matching the given pipeline will be returned

filterId int? (default ()) - If supplied, only deals matching the given filter will be returned

excludeDeals decimal? (default ()) - Whether to exclude deals list (1) or not (0). Note that when deals are excluded, the timeline summary (counts and values) is still returned.

totalsConvertCurrency string? (default ()) - 3-letter currency code of any of the supported currencies. When supplied, totals_converted is returned per each interval which contains the currency-converted total amounts in the given currency. You may also set this parameter to default_currency in which case users default currency is used.

Return Type

GetDealsTimelineResponse200|error - Get open and won Deals, grouped by the defined interval of time

getDeal

Isolated FunctionRemote Function

function getDeal(int id) returns GetDealResponse200|error

Get details of a deal

Parameters

id int - ID of the deal

Return Type

GetDealResponse200|error - Get a Deal by its ID

updateDeal

Isolated FunctionRemote Function

function updateDeal(int id, BasicDeal payload) returns DealResponse200|error

Update a deal

Parameters

id int - ID of the deal

payload BasicDeal - BasicDeal request

Return Type

DealResponse200|error - Add a Deal

deleteDeal

Isolated FunctionRemote Function

function deleteDeal(int id) returns DeleteDealResponse200|error

Delete a deal

Parameters

id int - ID of the deal

Return Type

DeleteDealResponse200|error - Delete a Deal

getDealActivities

Isolated FunctionRemote Function

function getDealActivities(int id, int 'start, int? 'limit, decimal? done, string? exclude) returns GetDealActivitiesResponse200|error

List activities associated with a deal

Parameters

id int - ID of the deal

'start int (default 0) - Pagination start

'limit int? (default ()) - Items shown per page

done decimal? (default ()) - Whether the activity is done or not. 0 = Not done, 1 = Done. If omitted returns both Done and Not done activities.

exclude string? (default ()) - A comma-separated string of activity IDs to exclude from result

Return Type

GetDealActivitiesResponse200|error - success

duplicateDeal

Isolated FunctionRemote Function

function duplicateDeal(int id) returns DuplicateDealResponse200|error

Duplicate deal

Parameters

id int - ID of the deal

Return Type

DuplicateDealResponse200|error - Duplicate a Deal

getDealFiles

Isolated FunctionRemote Function

function getDealFiles(int id, int 'start, int? 'limit, decimal? includeDeletedFiles, string? sort) returns GetAssociatedFilesResponse200|error

List files attached to a deal

Parameters

id int - ID of the deal

'start int (default 0) - Pagination start

'limit int? (default ()) - Items shown per page

includeDeletedFiles decimal? (default ()) - When enabled, the list of files will also include deleted files. Please note that trying to download these files will not work.

sort string? (default ()) - Field names and sorting mode separated by a comma (field_name_1 ASC, field_name_2 DESC). Only first-level field keys are supported (no nested keys). Supported fields: id, user_id, deal_id, person_id, org_id, product_id, add_time, update_time, file_name, file_type, file_size, comment.

Return Type

GetAssociatedFilesResponse200|error - success

getDealUpdates

Isolated FunctionRemote Function

function getDealUpdates(int id, int 'start, int? 'limit, string? allChanges, string? items) returns GetDealUpdatesResponse200|error

List updates about a deal

Parameters

id int - ID of the deal

'start int (default 0) - Pagination start

'limit int? (default ()) - Items shown per page

allChanges string? (default ()) - Whether to show custom field updates or not. 1 = Include custom field changes. If omitted returns changes without custom field updates.

items string? (default ()) - A comma-separated string for filtering out item specific updates. (Possible values - activity, plannedActivity, note, file, change, deal, follower, participant, mailMessage, mailMessageWithAttachment, invoice, activityFile, document)

Return Type

GetDealUpdatesResponse200|error - Get the Deal Updates

getDealFollowers

Isolated FunctionRemote Function

function getDealFollowers(int id) returns GetAssociatedFollowersResponse200|error

List followers of a deal

Parameters

id int - ID of the deal

Return Type

GetAssociatedFollowersResponse200|error - success

addDealFollower

Isolated FunctionRemote Function

function addDealFollower(int id, AddDealFollowerRequest payload) returns AddDealFollowerResponse200|error

Add a follower to a deal

Parameters

id int - ID of the deal

payload AddDealFollowerRequest - addDealFollower request

Return Type

AddDealFollowerResponse200|error - Add a Follower to a Deal

deleteDealFollower

Isolated FunctionRemote Function

function deleteDealFollower(int id, int followerId) returns DeleteDealFollowerResponse200|error

Delete a follower from a deal

Parameters

id int - ID of the deal

followerId int - ID of the follower

Return Type

DeleteDealFollowerResponse200|error - Delete a Follower from a Deal

getDealMailMessages

Isolated FunctionRemote Function

function getDealMailMessages(int id, int 'start, int? 'limit) returns GetAssociatedMailMessagesResponse200|error

List mail messages associated with a deal

Parameters

id int - ID of the deal

'start int (default 0) - Pagination start

'limit int? (default ()) - Items shown per page

Return Type

GetAssociatedMailMessagesResponse200|error - success

mergeDeals

Isolated FunctionRemote Function

function mergeDeals(int id, MergeDealsRequest payload) returns MergeDealsResponse200|error

Merge two deals

Parameters

id int - ID of the deal

payload MergeDealsRequest - MergeDeals request

Return Type

MergeDealsResponse200|error - Merges a Deal with another Deal.

getDealParticipants

Isolated FunctionRemote Function

function getDealParticipants(int id, int 'start, int? 'limit) returns GetDealParticipantsResponse200|error

List participants of a deal

Parameters

id int - ID of the deal

'start int (default 0) - Pagination start

'limit int? (default ()) - Items shown per page

Return Type

GetDealParticipantsResponse200|error - Get all Deal participants by the DealID

addDealParticipant

Isolated FunctionRemote Function

function addDealParticipant(int id, AddDealParticipantRequest payload) returns AddDealParticipantResponse200|error

Add a participant to a deal

Parameters

id int - ID of the deal

payload AddDealParticipantRequest - AddDealParticipant request

Return Type

AddDealParticipantResponse200|error - Add new participant to the Deal

deleteDealParticipant

Isolated FunctionRemote Function

function deleteDealParticipant(int id, int dealParticipantId) returns DeleteDealParticipantResponse200|error

Delete a participant from a deal

Parameters

id int - ID of the deal

dealParticipantId int - ID of the deal participant

Return Type

DeleteDealParticipantResponse200|error - Delete a Participant from a Deal

getDealUsers

Isolated FunctionRemote Function

function getDealUsers(int id) returns ListPermittedUsersResponse200|error

List permitted users

Parameters

id int - ID of the deal

Return Type

ListPermittedUsersResponse200|error - success

getDealPersons

Isolated FunctionRemote Function

function getDealPersons(int id, int 'start, int? 'limit) returns ListPersonsResponse200|error

List all persons associated with a deal

Parameters

id int - ID of the deal

'start int (default 0) - Pagination start

'limit int? (default ()) - Items shown per page

Return Type

ListPersonsResponse200|error - success

getDealProducts

Isolated FunctionRemote Function

function getDealProducts(int id, int 'start, int? 'limit, decimal? includeProductData) returns ListProductsResponse200|error

List products attached to a deal

Parameters

id int - ID of the deal

'start int (default 0) - Pagination start

'limit int? (default ()) - Items shown per page

includeProductData decimal? (default ()) - Whether to fetch product data along with each attached product (1) or not (0, default).

Return Type

ListProductsResponse200|error - success

addDealProduct

Isolated FunctionRemote Function

function addDealProduct(int id, AddDealProductRequest payload) returns GetAddProductAttachementResponse200|error

Add a product to the deal, eventually creating a new item called a deal-product

Parameters

id int - ID of the deal

payload AddDealProductRequest - AddDealProduct request

Return Type

GetAddProductAttachementResponse200|error - Add a Product to the Deal

updateDealProduct

Isolated FunctionRemote Function

function updateDealProduct(int id, int productAttachmentId, BasicDealProductRequest payload) returns GetProductAttachementResponse200|error

Update product attachment details of the deal-product (a product already attached to a deal)

Parameters

id int - ID of the deal

productAttachmentId int - ID of the deal-product (the ID of the product attached to the deal)

payload BasicDealProductRequest - BasicDealProduct request

Return Type

GetProductAttachementResponse200|error - Update Product attachment details

deleteDealProduct

Isolated FunctionRemote Function

function deleteDealProduct(int id, int productAttachmentId) returns DeleteDealProductResponse200|error

Delete an attached product from a deal

Parameters

id int - ID of the deal

productAttachmentId int - Product attachment ID. This is returned as product_attachment_id after attaching a product to a deal or as id when listing the products attached to a deal.

Return Type

DeleteDealProductResponse200|error - Delete an attached Product from a Deal

getDealFields

Isolated FunctionRemote Function

function getDealFields() returns FieldsResponse200|error

Get all deal fields

Return Type

FieldsResponse200|error - success

addDealField

Isolated FunctionRemote Function

function addDealField(CreateFieldRequest payload) returns FieldResponse200|error

Add a new deal field

Parameters

payload CreateFieldRequest - CreateField request

Return Type

FieldResponse200|error - success

deleteDealFields

Isolated FunctionRemote Function

function deleteDealFields(string ids) returns DeleteFieldsResponse200|error

Delete multiple deal fields in bulk

Parameters

ids string - Comma-separated field IDs to delete

Return Type

DeleteFieldsResponse200|error - success

getDealField

Isolated FunctionRemote Function

function getDealField(int id) returns FieldResponse200|error

Get one deal field

Parameters

id int - ID of the field

Return Type

FieldResponse200|error - success

updateDealField

Isolated FunctionRemote Function

function updateDealField(int id, UpdateFieldRequest payload) returns FieldResponse200|error

Update a deal field

Parameters

id int - ID of the field

payload UpdateFieldRequest - UpdateField request

Return Type

FieldResponse200|error - success

deleteDealField

Isolated FunctionRemote Function

function deleteDealField(int id) returns DeleteFieldResponse200|error

Delete a deal field

Parameters

id int - ID of the field

Return Type

DeleteFieldResponse200|error - success

getFiles

Isolated FunctionRemote Function

function getFiles(int 'start, int? 'limit, decimal? includeDeletedFiles, string? sort) returns GetFilesResponse200|error

Get all files

Parameters

'start int (default 0) - Pagination start

'limit int? (default ()) - Items shown per page

includeDeletedFiles decimal? (default ()) - When enabled, the list of files will also include deleted files. Please note that trying to download these files will not work.

sort string? (default ()) - Field names and sorting mode separated by a comma (field_name_1 ASC, field_name_2 DESC). Only first-level field keys are supported (no nested keys). Supported fields: id, user_id, deal_id, person_id, org_id, product_id, add_time, update_time, file_name, file_type, file_size, comment.

Return Type

GetFilesResponse200|error - Get data about all uploaded to Pipedrive files.

addFileAndLinkIt

Isolated FunctionRemote Function

function addFileAndLinkIt(AddFileAndLinkItRequest payload) returns AddFileAndLinkItResponse200|error

Create a remote file and link it to an item

Parameters

payload AddFileAndLinkItRequest - AddFileAndLinkIt request

Return Type

AddFileAndLinkItResponse200|error - Creates a new empty file in the remote location (googledrive) that will be linked to the item you supply - deal, person or organization

linkFileToItem

Isolated FunctionRemote Function

function linkFileToItem(LinkFileToItemRequest payload) returns LinkFileToItemResponse200|error

Link a remote file to an item

Parameters

payload LinkFileToItemRequest - LinkFileToItem request

Return Type

LinkFileToItemResponse200|error - Links an existing remote file (googledrive) to the item you supply - deal, person, organization

getFile

Isolated FunctionRemote Function

function getFile(int id) returns GetFileResponse200|error

Get one file

Parameters

id int - ID of the file

Return Type

GetFileResponse200|error - Get data about one specific uploaded to Pipedrive file

updateFile

Isolated FunctionRemote Function

function updateFile(int id, UpdateFileRequest payload) returns UpdateFileResponse200|error

Update file details

Parameters

id int - ID of the file

payload UpdateFileRequest - UpdateFile request

Return Type

UpdateFileResponse200|error - Update file name and description.

deleteFile

Isolated FunctionRemote Function

function deleteFile(int id) returns DeleteFileResponse200|error

Delete a file

Parameters

id int - ID of the file

Return Type

DeleteFileResponse200|error - Delete a file from Pipedrive

downloadFile

Isolated FunctionRemote Function

function downloadFile(int id) returns string|error

Download one file

Parameters

id int - ID of the file

Return Type

string|error - success

getFilters

Isolated FunctionRemote Function

function getFilters(string? 'type) returns GetFiltersResponse200|error

Get all filters

Parameters

'type string? (default ()) - The types of filters to fetch

Return Type

GetFiltersResponse200|error - success

addFilter

Isolated FunctionRemote Function

function addFilter(AddFilterRequest payload) returns PostFilterResponse200|error

Add a new filter

Parameters

payload AddFilterRequest - AddFilter request

Return Type

PostFilterResponse200|error - success

deleteFilters

Isolated FunctionRemote Function

function deleteFilters(string ids) returns DeleteFiltersResponse200|error

Delete multiple filters in bulk

Parameters

ids string - Comma-separated filter IDs to delete

Return Type

DeleteFiltersResponse200|error - success

getFilterHelpers

Isolated FunctionRemote Function

function getFilterHelpers() returns json|error

Get all filter helpers

Return Type

json|error - success

getFilter

Isolated FunctionRemote Function

function getFilter(int id) returns GetFilterResponse200|error

Get one filter

Parameters

id int - The ID of the filter

Return Type

GetFilterResponse200|error - success

updateFilter

Isolated FunctionRemote Function

function updateFilter(int id, UpdateFilterRequest payload) returns PostFilterResponse200|error

Update filter

Parameters

id int - The ID of the filter

payload UpdateFilterRequest - UpdateFilter request

Return Type

PostFilterResponse200|error - success

deleteFilter

Isolated FunctionRemote Function

function deleteFilter(int id) returns DeleteFilterResponse200|error

Delete a filter

Parameters

id int - The ID of the filter

Return Type

DeleteFilterResponse200|error - success

getGlobalMessages

Isolated FunctionRemote Function

function getGlobalMessages(int 'limit) returns GetGlobalMessagesResponse200|error

Get global messages

Parameters

'limit int (default 1) - Number of messages to get from 1 to 100. The message number 1 is returned by default.

Return Type

GetGlobalMessagesResponse200|error - Get all Global Messages

deleteGlobalMessage

Isolated FunctionRemote Function

function deleteGlobalMessage(int id) returns DeleteGlobalMessageResponse200|error

Dismiss a global message

Parameters

id int - ID of global message to be dismissed.

Return Type

DeleteGlobalMessageResponse200|error - Removes a Global Message by ID

addGoal

Isolated FunctionRemote Function

function addGoal(AddGoalRequest payload) returns AddOrUpdateGoalResponse200|error

Add a new goal

Parameters

payload AddGoalRequest - AddGoal request

Return Type

AddOrUpdateGoalResponse200|error - Successful response containing payload in the data.goal object.

getGoals

Isolated FunctionRemote Function

function getGoals(string? typeName, string? title, boolean isActive, int? assigneeId, string? assigneeType, decimal? expectedOutcomeTarget, string? expectedOutcomeTrackingMetric, int? expectedOutcomeCurrencyId, int? typeParamsPipelineId, int? typeParamsStageId, int? typeParamsActivityTypeId, string? periodStart, string? periodEnd) returns GetGoalsResponse200|error

Find goals

Parameters

typeName string? (default ()) - Type of the goal. If provided, everyone's goals will be returned.

title string? (default ()) - Title of the goal.

isActive boolean (default true) - Whether goal is active or not.

assigneeId int? (default ()) - ID of the user who's goal to fetch. When omitted, only your goals will be returned.

assigneeType string? (default ()) - Type of the goal's assignee. If provided, everyone's goals will be returned.

expectedOutcomeTarget decimal? (default ()) - Numeric value of the outcome. If provided, everyone's goals will be returned.

expectedOutcomeTrackingMetric string? (default ()) - Tracking metric of the expected outcome of the goal. If provided, everyone's goals will be returned.

expectedOutcomeCurrencyId int? (default ()) - Numeric ID of the goal's currency. Only applicable to goals with expected_outcome.tracking_metric with value sum. If provided, everyone's goals will be returned.

typeParamsPipelineId int? (default ()) - ID of the pipeline or null for all pipelines. If provided, everyone's goals will be returned.

typeParamsStageId int? (default ()) - ID of the stage. Applicable to only deals_progressed type of goals. If provided, everyone's goals will be returned.

typeParamsActivityTypeId int? (default ()) - ID of the activity type. Applicable to only activities_completed or activities_added types of goals. If provided, everyone's goals will be returned.

periodStart string? (default ()) - Start date of the period for which to find goals. Date in format of YYYY-MM-DD. When period.start is provided, period.end must be provided too.

periodEnd string? (default ()) - End date of the period for which to find goals. Date in format of YYYY-MM-DD.

Return Type

GetGoalsResponse200|error - Successful response containing payload in the data.goal object.

updateGoal

Isolated FunctionRemote Function

function updateGoal(string id, BasicGoalRequest payload) returns AddOrUpdateGoalResponse200|error

Update existing goal

Parameters

id string - ID of the goal to be updated.

payload BasicGoalRequest - BasicGoal request

Return Type

AddOrUpdateGoalResponse200|error - Successful response containing payload in the data.goal object.

deleteGoal

Isolated FunctionRemote Function

function deleteGoal(string id) returns DeleteGoalResponse200|error

Delete existing goal

Parameters

id string - ID of the goal to be deleted.

Return Type

DeleteGoalResponse200|error - Successful response with id 'success' field only

getGoalResult

Isolated FunctionRemote Function

function getGoalResult(string id, string periodStart, string periodEnd) returns GetGoalResultResponse200|error

Get result of a goal

Parameters

id string - ID of the goal that the results are looked for.

periodStart string - Start date of the period for which to find progress of a goal. Date in format of YYYY-MM-DD.

periodEnd string - End date of the period for which to find progress of a goal. Date in format of YYYY-MM-DD.

Return Type

GetGoalResultResponse200|error - Successful response containing payload in the data.goal object.

searchItem

Isolated FunctionRemote Function

function searchItem(string term, string? itemTypes, string? fields, boolean? searchForRelatedItems, boolean? exactMatch, string? includeFields, int 'start, int? 'limit) returns SearchItemResponse200|error

Perform a search from multiple item types

Parameters

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

itemTypes string? (default ()) - A comma-separated string array. The type of items to perform the search from. Defaults to all.

fields string? (default ()) - A comma-separated string array. The fields to perform the search from. Defaults to all. Relevant for each item type are:<br> <table> <tr><th><b>Item type</b></th><th><b>Field</b></th></tr> <tr><td>Deal</td><td>custom_fields, notes, title</td></tr> <tr><td>Person</td><td>custom_fields, email, name, notes, phone</td></tr> <tr><td>Organization</td><td>address, custom_fields, name, notes</td></tr> <tr><td>Product</td><td>code, custom_fields, name</td></tr> <tr><td>Lead</td><td>email, organization_name, person_name, phone, title</td></tr> <tr><td>File</td><td>name</td></tr> <tr><td>Mail attachment</td><td>name</td></tr> </table> <br> When searching for Leads, the email, organization_name, person_name, and phone fields will return results only for Leads not linked to contacts. For searching Leads by Person or Organization values, please use search_for_related_items.

searchForRelatedItems boolean? (default ()) - When enabled, the response will include up to 100 newest related Leads and 100 newest related Deals for each found Person and Organization and up to 100 newest related Persons for each found Organization.

exactMatch boolean? (default ()) - When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.

includeFields string? (default ()) - A comma-separated string array. Supports including optional fields in the results which are not provided by default.

'start int (default 0) - Pagination start. Note that the pagination is based on main results and does not include related items when using search_for_related_items parameter.

'limit int? (default ()) - Items shown per page

Return Type

SearchItemResponse200|error - success

searchItemByField

Isolated FunctionRemote Function

function searchItemByField(string term, string fieldType, string fieldKey, boolean exactMatch, boolean? returnItemIds, int? 'start, int? 'limit) returns SearchItemByFieldResponse200|error

Perform a search using a specific field from an item type

Parameters

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

fieldType string - The type of the field to perform the search from

fieldKey string - The key of the field to search from. The field key can be obtained by fetching the list of the fields using any of the fields' API GET methods (dealFields, personFields, etc.).

exactMatch boolean (default false) - When enabled, only full exact matches against the given term are returned. The search <b>is</b> case sensitive.

returnItemIds boolean? (default ()) - Whether to return the IDs of the matching items or not. When not set or set to 0 or false, only distinct values of the searched field are returned. When set to 1 or true, the ID of each found item is returned.

'start int? (default ()) - Pagination start

'limit int? (default ()) - Items shown per page

Return Type

SearchItemByFieldResponse200|error - success

getLeads

Isolated FunctionRemote Function

function getLeads(int? 'limit, int? 'start, string? archivedStatus) returns GetLeadsResponse200|error

Get all leads

Parameters

'limit int? (default ()) - For pagination, the limit of entries to be returned. If not provided, 100 items will be returned.

'start int? (default ()) - For pagination, the position that represents the first result for the page

archivedStatus string? (default ()) - Filtering based on archived status of a Lead. If not provided, All is used.

Return Type

GetLeadsResponse200|error - Successful response containing payload in the data field.

addLead

Isolated FunctionRemote Function

function addLead(AddLeadRequest payload) returns OneLeadResponse200|error

Add a lead

Parameters

payload AddLeadRequest - AddLead request

Return Type

OneLeadResponse200|error - Successful response containing payload in the data field.

getLead

Isolated FunctionRemote Function

function getLead(string id) returns OneLeadResponse200|error

Get one lead

Parameters

id string - The ID of the Lead

Return Type

OneLeadResponse200|error - Successful response containing payload in the data field.

deleteLead

Isolated FunctionRemote Function

function deleteLead(string id) returns LeadIdResponse200|error

Delete a lead

Parameters

id string - The ID of the Lead

Return Type

LeadIdResponse200|error - Successful response with id value only. Used in DELETE calls.

updateLead

Isolated FunctionRemote Function

function updateLead(string id, UpdateLeadRequest payload) returns OneLeadResponse200|error

Update a lead

Parameters

id string - The ID of the Lead

payload UpdateLeadRequest - UpdateLead request

Return Type

OneLeadResponse200|error - Successful response containing payload in the data field.

getLeadLabels

Isolated FunctionRemote Function

function getLeadLabels() returns GetLeadLabelsResponse200|error

Get all lead labels

Return Type

GetLeadLabelsResponse200|error - Successful response containing payload in the data field.

addLeadLabel

Isolated FunctionRemote Function

function addLeadLabel(AddLeadLabelRequest payload) returns AddOrUpdateLeadLabelResponse200|error

Add a lead label

Parameters

payload AddLeadLabelRequest - AddLeadLabel request

Return Type

AddOrUpdateLeadLabelResponse200|error - Successful response containing payload in the data field.

deleteLeadLabel

Isolated FunctionRemote Function

function deleteLeadLabel(string id) returns LeadIdResponse200|error

Delete a lead label

Parameters

id string - The ID of the Lead Label

Return Type

LeadIdResponse200|error - Successful response with id value only. Used in DELETE calls.

updateLeadLabel

Isolated FunctionRemote Function

function updateLeadLabel(string id, UpdateLeadLabelRequest payload) returns AddOrUpdateLeadLabelResponse200|error

Update a lead label

Parameters

id string - The ID of the Lead Label

payload UpdateLeadLabelRequest - UpdateLeadLabel request

Return Type

AddOrUpdateLeadLabelResponse200|error - Successful response containing payload in the data field.

getLeadSources

Isolated FunctionRemote Function

function getLeadSources() returns GetLeadSourcesResponse200|error

Get all lead sources

Return Type

GetLeadSourcesResponse200|error - The successful response containing payload in the data field.

getMailMessage

Isolated FunctionRemote Function

function getMailMessage(int id, decimal includeBody) returns MailMessageResponse200|error

Get one mail message

Parameters

id int - ID of the mail message to fetch.

includeBody decimal (default 1) - Whether to include full message body or not. 0 = Don't include, 1 = Include

Return Type

MailMessageResponse200|error - The mail messages that are being synced with Pipedrive

getMailThreads

Isolated FunctionRemote Function

function getMailThreads(string folder, int 'start, int? 'limit) returns GetMailThreadsResponse200|error

Get mail threads

Parameters

folder string - Type of folder to fetch.

'start int (default 0) - Pagination start

'limit int? (default ()) - Items shown per page

Return Type

GetMailThreadsResponse200|error - Get mail threads

getMailThread

Isolated FunctionRemote Function

function getMailThread(int id) returns GetOneMailThreadResponse200|error

Get one mail thread

Parameters

id int - ID of the mail thread

Return Type

GetOneMailThreadResponse200|error - Get mail threads

updateMailThreadDetails

Isolated FunctionRemote Function

function updateMailThreadDetails(int id, UpdateMailThreadDetailsRequest payload) returns UpdateMailThreadDetailsResponse200|error

Update mail thread details

Parameters

id int - ID of the mail thread

payload UpdateMailThreadDetailsRequest - UpdateMailThreadDetails request

Return Type

UpdateMailThreadDetailsResponse200|error - Updates the properties of a mail thread.

deleteMailThread

Isolated FunctionRemote Function

function deleteMailThread(int id) returns DeleteMailThreadResponse200|error

Delete mail thread

Parameters

id int - ID of the mail thread

Return Type

DeleteMailThreadResponse200|error - Marks mail thread as deleted.

getMailThreadMessages

Isolated FunctionRemote Function

function getMailThreadMessages(int id) returns GetAllMailMessagesOfMailThreadResponse200|error

Get all mail messages of mail thread

Parameters

id int - ID of the mail thread

Return Type

GetAllMailMessagesOfMailThreadResponse200|error - Get mail messages from thread

getNotes

Isolated FunctionRemote Function

function getNotes(int? userId, string? leadId, int? dealId, int? personId, int? orgId, int 'start, int? 'limit, string? sort, string? startDate, string? endDate, decimal? pinnedToLeadFlag, decimal? pinnedToDealFlag, decimal? pinnedToOrganizationFlag, decimal? pinnedToPersonFlag) returns GetNotesResponse200|error

Get all notes

Parameters

userId int? (default ()) - The ID of the user whose notes to fetch. If omitted, notes by all users will be returned.

leadId string? (default ()) - The ID of the lead which notes to fetch. If omitted, notes about all leads will be returned.

dealId int? (default ()) - The ID of the deal which notes to fetch. If omitted, notes about all deals will be returned.

personId int? (default ()) - The ID of the person whose notes to fetch. If omitted, notes about all persons will be returned.

orgId int? (default ()) - The ID of the organization which notes to fetch. If omitted, notes about all organizations will be returned

'start int (default 0) - Pagination start

'limit int? (default ()) - Items shown per page

sort string? (default ()) - Field names and sorting mode separated by a comma (field_name_1 ASC, field_name_2 DESC). Only first-level field keys are supported (no nested keys). Supported fields: id, user_id, deal_id, person_id, org_id, content, add_time, update_time.

startDate string? (default ()) - Date in format of YYYY-MM-DD from which notes to fetch.

endDate string? (default ()) - Date in format of YYYY-MM-DD until which notes to fetch to.

pinnedToLeadFlag decimal? (default ()) - If set, then results are filtered by note to lead pinning state

pinnedToDealFlag decimal? (default ()) - If set, then results are filtered by note to deal pinning state

pinnedToOrganizationFlag decimal? (default ()) - If set, then results are filtered by note to organization pinning state

pinnedToPersonFlag decimal? (default ()) - If set, then results are filtered by note to person pinning state

Return Type

GetNotesResponse200|error - Get all Notes

addNote

Isolated FunctionRemote Function

function addNote(NoteRequest payload) returns OneNoteResponse200|error

Add a note

Parameters

payload NoteRequest - Note request

Return Type

OneNoteResponse200|error - Add, update or get a Note

getNote

Isolated FunctionRemote Function

function getNote(int id) returns OneNoteResponse200|error

Get one note

Parameters

id int - ID of the note

Return Type

OneNoteResponse200|error - Add, update or get a Note

updateNote

Isolated FunctionRemote Function

function updateNote(int id, Noterequest1 payload) returns OneNoteResponse200|error

Update a note

Parameters

id int - ID of the note

payload Noterequest1 - Note request

Return Type

OneNoteResponse200|error - Add, update or get a Note

deleteNote

Isolated FunctionRemote Function

function deleteNote(int id) returns DeleteNoteResponse200|error

Delete a note

Parameters

id int - ID of the note

Return Type

DeleteNoteResponse200|error - Delete a Note

getNoteComments

Isolated FunctionRemote Function

function getNoteComments(int id, int 'start, int? 'limit) returns GetCommentsResponse200|error

Get all comments for a note

Parameters

id int - ID of the note

'start int (default 0) - Pagination start

'limit int? (default ()) - Items shown per page

Return Type

GetCommentsResponse200|error - Get all Comments

addNoteComment

Isolated FunctionRemote Function

function addNoteComment(int id, CommentPostPutObject payload) returns OneCommentResponse200|error

Add a comment to a note

Parameters

id int - ID of the note

payload CommentPostPutObject - CommentPostPutObject request

Return Type

OneCommentResponse200|error - Add, update or get a comment

getComment

Isolated FunctionRemote Function

function getComment(int id, string commentId) returns OneCommentResponse200|error

Get one comment

Parameters

id int - ID of the note

commentId string - ID of the comment

Return Type

OneCommentResponse200|error - Add, update or get a comment

updateCommentForNote

Isolated FunctionRemote Function

function updateCommentForNote(int id, string commentId, Commentpostputobject1 payload) returns OneCommentResponse200|error

Update a comment related to a note

Parameters

id int - ID of the note

commentId string - ID of the comment

payload Commentpostputobject1 - CommentPostPutObject request

Return Type

OneCommentResponse200|error - Add, update or get a comment

deleteComment

Isolated FunctionRemote Function

function deleteComment(int id, string commentId) returns DeleteCommentResponse200|error

Delete a comment related to a note

Parameters

id int - ID of the note

commentId string - ID of the comment

Return Type

DeleteCommentResponse200|error - Delete a Comment

getNoteFields

Isolated FunctionRemote Function

function getNoteFields() returns GetNoteFieldsResponse200|error

Get all note fields

Return Type

GetNoteFieldsResponse200|error - success

getOrganizations

Isolated FunctionRemote Function

function getOrganizations(int? userId, int? filterId, string? firstChar, int 'start, int? 'limit, string? sort) returns GetOrganizationsResponse200|error

Get all organizations

Parameters

userId int? (default ()) - If supplied, only organizations owned by the given user will be returned. However, filter_id takes precedence over user_id when both are supplied.

filterId int? (default ()) - ID of the filter to use

firstChar string? (default ()) - If supplied, only organizations whose name starts with the specified letter will be returned (case insensitive).

'start int (default 0) - Pagination start

'limit int? (default ()) - Items shown per page

sort string? (default ()) - Field names and sorting mode separated by a comma (field_name_1 ASC, field_name_2 DESC). Only first-level field keys are supported (no nested keys).

Return Type

GetOrganizationsResponse200|error - success

addOrganization

Isolated FunctionRemote Function

function addOrganization(AddOrganizationRequest payload) returns AddOrganizationResponse200|error

Add an organization

Parameters

payload AddOrganizationRequest - AddOrganization request

Return Type

AddOrganizationResponse200|error - success

deleteOrganizations

Isolated FunctionRemote Function

function deleteOrganizations(string ids) returns DeleteOrganizationsResponse200|error

Delete multiple organizations in bulk

Parameters

ids string - Comma-separated IDs that will be deleted

Return Type

DeleteOrganizationsResponse200|error - success

searchOrganization

Isolated FunctionRemote Function

function searchOrganization(string term, string? fields, boolean? exactMatch, int 'start, int? 'limit) returns SearchOrganizationResponse200|error

Search organizations

Parameters

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

fields string? (default ()) - A comma-separated string array. The fields to perform the search from. Defaults to all of them.

exactMatch boolean? (default ()) - When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.

'start int (default 0) - Pagination start. Note that the pagination is based on main results and does not include related items when using search_for_related_items parameter.

'limit int? (default ()) - Items shown per page

Return Type

SearchOrganizationResponse200|error - success

getOrganizationByName

DeprecatedIsolated FunctionRemote Function

function getOrganizationByName(string term, int 'start, int? 'limit) returns json|error

Find organizations by name

Parameters

term string - Search term to look for

'start int (default 0) - Pagination start

'limit int? (default ()) - Items shown per page

Return Type

json|error - success
Deprecated

getOrganization

Isolated FunctionRemote Function

function getOrganization(int id) returns GetOrganizationResponse200|error

Get details of an organization

Parameters

id int - The ID of the Organization

Return Type

GetOrganizationResponse200|error - success

updateOrganization

Isolated FunctionRemote Function

function updateOrganization(int id, BasicOrganization payload) returns UpdateOrganizationResponse200|error

Update an organization

Parameters

id int - The ID of the Organization

payload BasicOrganization - BasicOrganization request

Return Type

UpdateOrganizationResponse200|error - success

deleteOrganization

Isolated FunctionRemote Function

function deleteOrganization(int id) returns DeleteOrganizationResponse200|error

Delete an organization

Parameters

id int - The ID of the Organization

Return Type

DeleteOrganizationResponse200|error - success

getOrganizationActivities

Isolated FunctionRemote Function

function getOrganizationActivities(int id, int 'start, int? 'limit, decimal? done, string? exclude) returns GetAssociatedActivitiesResponse200|error

List activities associated with an organization

Parameters

id int - The ID of the Organization

'start int (default 0) - Pagination start

'limit int? (default ()) - Items shown per page

done decimal? (default ()) - Whether the activity is done or not. 0 = Not done, 1 = Done. If omitted returns both Done and Not done activities.

exclude string? (default ()) - A comma-separated string of activity IDs to exclude from result

Return Type

GetAssociatedActivitiesResponse200|error - success

getOrganizationDeals

Isolated FunctionRemote Function

function getOrganizationDeals(int id, int 'start, int? 'limit, string status, string? sort, decimal? onlyPrimaryAssociation) returns GetAssociatedDealsResponse200|error

List deals associated with an organization

Parameters

id int - The ID of the Organization

'start int (default 0) - Pagination start

'limit int? (default ()) - Items shown per page

status string (default "all_not_deleted") - Only fetch deals with specific status. If omitted, all not deleted deals are fetched.

sort string? (default ()) - Field names and sorting mode separated by a comma (field_name_1 ASC, field_name_2 DESC). Only first-level field keys are supported (no nested keys).

onlyPrimaryAssociation decimal? (default ()) - If set, only deals that are directly associated to the organization are fetched. If not set (default), all deals are fetched that are either directly or indirectly related to the organization. Indirect relations include relations through custom, organization-type fields and through persons of the given organization.

Return Type

GetAssociatedDealsResponse200|error - success

getOrganizationFiles

Isolated FunctionRemote Function

function getOrganizationFiles(int id, int 'start, int? 'limit, decimal? includeDeletedFiles, string? sort) returns GetAssociatedFilesResponse200|error

List files attached to an organization

Parameters

id int - The ID of the Organization

'start int (default 0) - Pagination start

'limit int? (default ()) - Items shown per page

includeDeletedFiles decimal? (default ()) - When enabled, the list of files will also include deleted files. Please note that trying to download these files will not work.

sort string? (default ()) - Field names and sorting mode separated by a comma (field_name_1 ASC, field_name_2 DESC). Only first-level field keys are supported (no nested keys). Supported fields: id, user_id, deal_id, person_id, org_id, product_id, add_time, update_time, file_name, file_type, file_size, comment.

Return Type

GetAssociatedFilesResponse200|error - success

getOrganizationUpdates

Isolated FunctionRemote Function

function getOrganizationUpdates(int id, int 'start, int? 'limit, string? allChanges, string? items) returns GetAssociatedUpdatesResponse200|error

List updates about an organization

Parameters

id int - The ID of the Organization

'start int (default 0) - Pagination start

'limit int? (default ()) - Items shown per page

allChanges string? (default ()) - Whether to show custom field updates or not. 1 = Include custom field changes. If omitted returns changes without custom field updates.

items string? (default ()) - A comma-separated string for filtering out item specific updates. (Possible values - activity, plannedActivity, note, file, change, deal, follower, participant, mailMessage, mailMessageWithAttachment, invoice, activityFile, document)

Return Type

GetAssociatedUpdatesResponse200|error - Get the Organization Updates

getOrganizationFollowers

Isolated FunctionRemote Function

function getOrganizationFollowers(int id) returns Getassociatedfollowersresponse2001|error

List followers of an organization

Parameters

id int - The ID of the Organization

Return Type

Getassociatedfollowersresponse2001|error - success

addOrganizationFollower

Isolated FunctionRemote Function

function addOrganizationFollower(int id, AddOrganizationFollowerRequest payload) returns AddOrganizationFollowerResponse200|error

Add a follower to an organization

Parameters

id int - The ID of the Organization

payload AddOrganizationFollowerRequest - AddOrganizationFollower request

Return Type

AddOrganizationFollowerResponse200|error - success

deleteOrganizationFollower

Isolated FunctionRemote Function

function deleteOrganizationFollower(int id, int followerId) returns DeleteOrganizationFollowerResponse200|error

Delete a follower from an organization

Parameters

id int - The ID of the Organization

followerId int - The ID of the follower

Return Type

DeleteOrganizationFollowerResponse200|error - success

getOrganizationMailMessages

Isolated FunctionRemote Function

function getOrganizationMailMessages(int id, int 'start, int? 'limit) returns GetAssociatedMailMessagesResponse200|error

List mail messages associated with an organization

Parameters

id int - The ID of the Organization

'start int (default 0) - Pagination start

'limit int? (default ()) - Items shown per page

Return Type

GetAssociatedMailMessagesResponse200|error - success

mergeOrganizations

Isolated FunctionRemote Function

function mergeOrganizations(int id, MergeOrganizationsRequest payload) returns MergeOrganizationsResponse200|error

Merge two organizations

Parameters

id int - The ID of the Organization

payload MergeOrganizationsRequest - MergeOrganizations request

Return Type

MergeOrganizationsResponse200|error - success

getOrganizationUsers

Isolated FunctionRemote Function

function getOrganizationUsers(int id) returns Listpermittedusersresponse2001|error

List permitted users

Parameters

id int - The ID of the Organization

Return Type

Listpermittedusersresponse2001|error - success

getOrganizationPersons

Isolated FunctionRemote Function

function getOrganizationPersons(int id, int 'start, int? 'limit) returns ListPersonsResponse200|error

List persons of an organization

Parameters

id int - The ID of the Organization

'start int (default 0) - Pagination start

'limit int? (default ()) - Items shown per page

Return Type

ListPersonsResponse200|error - success

getOrganizationFields

Isolated FunctionRemote Function

function getOrganizationFields() returns FieldsResponse200|error

Get all organization fields

Return Type

FieldsResponse200|error - success

addOrganizationField

Isolated FunctionRemote Function

function addOrganizationField(Createfieldrequest1 payload) returns FieldResponse200|error

Add a new organization field

Parameters

payload Createfieldrequest1 - CreateField request

Return Type

FieldResponse200|error - success

deleteOrganizationFields

Isolated FunctionRemote Function

function deleteOrganizationFields(string ids) returns DeleteFieldsResponse200|error

Delete multiple organization fields in bulk

Parameters

ids string - Comma-separated field IDs to delete

Return Type

DeleteFieldsResponse200|error - success

getOrganizationField

Isolated FunctionRemote Function

function getOrganizationField(int id) returns FieldResponse200|error

Get one organization field

Parameters

id int - ID of the field

Return Type

FieldResponse200|error - success

updateOrganizationField

Isolated FunctionRemote Function

function updateOrganizationField(int id, Updatefieldrequest1 payload) returns FieldResponse200|error

Update an organization field

Parameters

id int - ID of the field

payload Updatefieldrequest1 - UpdateField request

Return Type

FieldResponse200|error - success

deleteOrganizationField

Isolated FunctionRemote Function

function deleteOrganizationField(int id) returns DeleteFieldResponse200|error

Delete an organization field

Parameters

id int - ID of the field

Return Type

DeleteFieldResponse200|error - success

getOrganizationRelationships

Isolated FunctionRemote Function

function getOrganizationRelationships(int orgId) returns GetOrganizationRelationshipsResponse200|error

Get all relationships for organization

Parameters

orgId int - ID of the organization to get relationships for

Return Type

GetOrganizationRelationshipsResponse200|error - success

addOrganizationRelationship

Isolated FunctionRemote Function

function addOrganizationRelationship(AddOrganizationRelationshipRequest payload) returns AddOrganizationRelationshipResponse200|error

Create an organization relationship

Parameters

payload AddOrganizationRelationshipRequest - AddOrganizationRelationship request

Return Type

AddOrganizationRelationshipResponse200|error - success

getOrganizationRelationship

Isolated FunctionRemote Function

function getOrganizationRelationship(int id, int? orgId) returns GetOrganizationRelationshipResponse200|error

Get one organization relationship

Parameters

id int - ID of the organization relationship

orgId int? (default ()) - ID of the base organization for the returned calculated values

Return Type

GetOrganizationRelationshipResponse200|error - success

updateOrganizationRelationship

Isolated FunctionRemote Function

function updateOrganizationRelationship(int id, OrganizationRelationshipRequest payload) returns UpdateOrganizationRelationshipResponse200|error

Update an organization relationship

Parameters

id int - ID of the organization relationship

payload OrganizationRelationshipRequest - OrganizationRelationship request

Return Type

UpdateOrganizationRelationshipResponse200|error - success

deleteOrganizationRelationship

Isolated FunctionRemote Function

function deleteOrganizationRelationship(int id) returns DeleteOrganizationRelationshipResponse200|error

Delete an organization relationship

Parameters

id int - ID of the organization relationship

Return Type

DeleteOrganizationRelationshipResponse200|error - success

getPermissionSets

Isolated FunctionRemote Function

function getPermissionSets() returns GetPermissionSetsResponse200|error

Get all Permission Sets

Return Type

GetPermissionSetsResponse200|error - Get all permissions

getPermissionSet

Isolated FunctionRemote Function

function getPermissionSet(int id) returns SinglePermissionSetResponse200|error

Get one Permission Set

Parameters

id int - ID of the permission set

Return Type

SinglePermissionSetResponse200|error - The Permission Set of a specific User ID

getPermissionSetAssignments

Isolated FunctionRemote Function

function getPermissionSetAssignments(int id, int 'start, int? 'limit) returns UserAssignmentsToPermissionSetResponse200|error

List Permission Set assignments

Parameters

id int - ID of the permission set

'start int (default 0) - Pagination start

'limit int? (default ()) - Items shown per page

Return Type

UserAssignmentsToPermissionSetResponse200|error - The Assignments of a specific User ID

getPersons

Isolated FunctionRemote Function

function getPersons(int? userId, int? filterId, string? firstChar, int 'start, int? 'limit, string? sort) returns GetPersonsResponse200|error

Get all persons

Parameters

userId int? (default ()) - If supplied, only persons owned by the given user will be returned. However, filter_id takes precedence over user_id when both are supplied.

filterId int? (default ()) - ID of the filter to use.

firstChar string? (default ()) - If supplied, only persons whose name starts with the specified letter will be returned (case insensitive).

'start int (default 0) - Pagination start

'limit int? (default ()) - Items shown per page

sort string? (default ()) - Field names and sorting mode separated by a comma (field_name_1 ASC, field_name_2 DESC). Only first-level field keys are supported (no nested keys).

Return Type

GetPersonsResponse200|error - success

addPerson

Isolated FunctionRemote Function

function addPerson(AddPersonRequest payload) returns AddPersonResponse200|error

Add a person

Parameters

payload AddPersonRequest - AddPerson request

Return Type

AddPersonResponse200|error - success

deletePersons

Isolated FunctionRemote Function

function deletePersons(string? ids) returns DeletePersonsResponse200|error

Delete multiple persons in bulk

Parameters

ids string? (default ()) - Comma-separated IDs that will be deleted

Return Type

DeletePersonsResponse200|error - success

searchPersons

Isolated FunctionRemote Function

function searchPersons(string term, string? fields, boolean? exactMatch, int? organizationId, string? includeFields, int 'start, int? 'limit) returns SearchPersonsResponse200|error

Search persons

Parameters

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

fields string? (default ()) - A comma-separated string array. The fields to perform the search from. Defaults to all of them.

exactMatch boolean? (default ()) - When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.

organizationId int? (default ()) - Will filter Deals by the provided Organization ID. The upper limit of found Deals associated with the Organization is 2000.

includeFields string? (default ()) - Supports including optional fields in the results which are not provided by default.

'start int (default 0) - Pagination start. Note that the pagination is based on main results and does not include related items when using search_for_related_items parameter.

'limit int? (default ()) - Items shown per page

Return Type

SearchPersonsResponse200|error - success

findPersonByName

DeprecatedIsolated FunctionRemote Function

function findPersonByName(string term, int? orgId, int 'start, int? 'limit, decimal? searchByEmail) returns json|error

Find persons by name

Parameters

term string - Search term to look for

orgId int? (default ()) - ID of the organization person is associated with.

'start int (default 0) - Pagination start

'limit int? (default ()) - Items shown per page

searchByEmail decimal? (default ()) - When enabled, term will only be matched against email addresses of people. Default: false

Return Type

json|error - success
Deprecated

getPerson

Isolated FunctionRemote Function

function getPerson(int id) returns GetPersonResponse200|error

Get details of a person

Parameters

id int - ID of a person

Return Type

GetPersonResponse200|error - success

updatePerson

Isolated FunctionRemote Function

function updatePerson(int id, BasicPersonRequest payload) returns UpdatePersonResponse200|error

Update a person

Parameters

id int - ID of a person

payload BasicPersonRequest - BasicPerson request

Return Type

UpdatePersonResponse200|error - success

deletePerson

Isolated FunctionRemote Function

function deletePerson(int id) returns DeletePersonResponse200|error

Delete a person

Parameters

id int - ID of a person

Return Type

DeletePersonResponse200|error - success

getPersonActivities

Isolated FunctionRemote Function

function getPersonActivities(int id, int 'start, int? 'limit, decimal? done, string? exclude) returns GetAssociatedActivitiesResponse200|error

List activities associated with a person

Parameters

id int - ID of a person

'start int (default 0) - Pagination start

'limit int? (default ()) - Items shown per page

done decimal? (default ()) - Whether the activity is done or not. 0 = Not done, 1 = Done. If omitted returns both Done and Not done activities.

exclude string? (default ()) - A comma-separated string of activity IDs to exclude from result

Return Type

GetAssociatedActivitiesResponse200|error - success

getPersonDeals

Isolated FunctionRemote Function

function getPersonDeals(int id, int 'start, int? 'limit, string status, string? sort) returns GetAssociatedDealsResponse200|error

List deals associated with a person

Parameters

id int - ID of a person

'start int (default 0) - Pagination start

'limit int? (default ()) - Items shown per page

status string (default "all_not_deleted") - Only fetch deals with specific status. If omitted, all not deleted deals are fetched.

sort string? (default ()) - Field names and sorting mode separated by a comma (field_name_1 ASC, field_name_2 DESC). Only first-level field keys are supported (no nested keys).

Return Type

GetAssociatedDealsResponse200|error - success

getPersonFiles

Isolated FunctionRemote Function

function getPersonFiles(int id, int 'start, int? 'limit, decimal? includeDeletedFiles, string? sort) returns GetAssociatedFilesResponse200|error

List files attached to a person

Parameters

id int - ID of a person

'start int (default 0) - Pagination start

'limit int? (default ()) - Items shown per page

includeDeletedFiles decimal? (default ()) - When enabled, the list of files will also include deleted files. Please note that trying to download these files will not work.

sort string? (default ()) - Field names and sorting mode separated by a comma (field_name_1 ASC, field_name_2 DESC). Only first-level field keys are supported (no nested keys). Supported fields: id, user_id, deal_id, person_id, org_id, product_id, add_time, update_time, file_name, file_type, file_size, comment.

Return Type

GetAssociatedFilesResponse200|error - success

getPersonUpdates

Isolated FunctionRemote Function

function getPersonUpdates(int id, int 'start, int? 'limit, string? allChanges, string? items) returns GetAssociatedPersonUpdatesResponse200|error

List updates about a person

Parameters

id int - ID of a person

'start int (default 0) - Pagination start

'limit int? (default ()) - Items shown per page

allChanges string? (default ()) - Whether to show custom field updates or not. 1 = Include custom field changes. If omitted returns changes without custom field updates.

items string? (default ()) - A comma-separated string for filtering out item specific updates. (Possible values - activity, plannedActivity, note, file, change, deal, follower, participant, mailMessage, mailMessageWithAttachment, invoice, activityFile, document)

Return Type

GetAssociatedPersonUpdatesResponse200|error - Get the Person Updates

getPersonFollowers

Isolated FunctionRemote Function

function getPersonFollowers(int id) returns GetAssociatedFollowersResponse200|error

List followers of a person

Parameters

id int - ID of a person

Return Type

GetAssociatedFollowersResponse200|error - success

addPersonFollower

Isolated FunctionRemote Function

function addPersonFollower(int id, AddPersonFollowerRequest payload) returns AddPersonFollowerResponse200|error

Add a follower to a person

Parameters

id int - ID of a person

payload AddPersonFollowerRequest - AddPersonFollower request

Return Type

AddPersonFollowerResponse200|error - success

deletePersonFollower

Isolated FunctionRemote Function

function deletePersonFollower(int id, int followerId) returns DeletePersonResponse200|error

Deletes a follower from a person.

Parameters

id int - ID of a person

followerId int - ID of the follower

Return Type

DeletePersonResponse200|error - success

getPersonMailMessages

Isolated FunctionRemote Function

function getPersonMailMessages(int id, int 'start, int? 'limit) returns GetAssociatedMailMessagesResponse200|error

List mail messages associated with a person

Parameters

id int - ID of a person

'start int (default 0) - Pagination start

'limit int? (default ()) - Items shown per page

Return Type

GetAssociatedMailMessagesResponse200|error - success

mergePersons

Isolated FunctionRemote Function

function mergePersons(int id, MergePersonsRequest payload) returns MergePersonsResponse200|error

Merge two persons

Parameters

id int - ID of a person

payload MergePersonsRequest - MergePersons request

Return Type

MergePersonsResponse200|error - success

getPersonUsers

Isolated FunctionRemote Function

function getPersonUsers(int id) returns Listpermittedusersresponse2001|error

List permitted users

Parameters

id int - ID of a person

Return Type

Listpermittedusersresponse2001|error - success

deletePersonPicture

Isolated FunctionRemote Function

function deletePersonPicture(int id) returns DeletePersonResponse200|error

Delete person picture

Parameters

id int - ID of a person

Return Type

DeletePersonResponse200|error - success

getPersonProducts

Isolated FunctionRemote Function

function getPersonProducts(int id, int 'start, int? 'limit) returns GetPersonProductsResponse200|error

List products associated with a person

Parameters

id int - ID of a person

'start int (default 0) - Pagination start

'limit int? (default ()) - Items shown per page

Return Type

GetPersonProductsResponse200|error - success

getPersonFields

Isolated FunctionRemote Function

function getPersonFields() returns FieldsResponse200|error

Get all person fields

Return Type

FieldsResponse200|error - success

addPersonField

Isolated FunctionRemote Function

function addPersonField(Createfieldrequest2 payload) returns FieldResponse200|error

Add a new person field

Parameters

payload Createfieldrequest2 - CreateField request

Return Type

FieldResponse200|error - success

deletePersonFields

Isolated FunctionRemote Function

function deletePersonFields(string ids) returns DeleteFieldsResponse200|error

Delete multiple person fields in bulk

Parameters

ids string - Comma-separated field IDs to delete

Return Type

DeleteFieldsResponse200|error - success

getPersonField

Isolated FunctionRemote Function

function getPersonField(int id) returns FieldResponse200|error

Get one person field

Parameters

id int - ID of the field

Return Type

FieldResponse200|error - success

updatePersonField

Isolated FunctionRemote Function

function updatePersonField(int id, Updatefieldrequest2 payload) returns FieldResponse200|error

Update a person field

Parameters

id int - ID of the field

payload Updatefieldrequest2 - UpdateField request

Return Type

FieldResponse200|error - success

deletePersonField

Isolated FunctionRemote Function

function deletePersonField(int id) returns DeleteFieldResponse200|error

Delete a person field

Parameters

id int - ID of the field

Return Type

DeleteFieldResponse200|error - success

getPipelines

Isolated FunctionRemote Function

function getPipelines() returns GetPipelinesResponse200|error

Get all pipelines

Return Type

GetPipelinesResponse200|error - Get all Pipelines

addPipeline

Isolated FunctionRemote Function

function addPipeline(PipelineRequest payload) returns AddPipelineResponse200|error

Add a new pipeline

Parameters

payload PipelineRequest - Pipeline request

Return Type

AddPipelineResponse200|error - Add Pipeline

getPipeline

Isolated FunctionRemote Function

function getPipeline(int id, string? totalsConvertCurrency) returns GetPipelineResponse200|error

Get one pipeline

Parameters

id int - ID of the pipeline

totalsConvertCurrency string? (default ()) - 3-letter currency code of any of the supported currencies. When supplied, per_stages_converted is returned in deals_summary which contains the currency-converted total amounts in the given currency per each stage. You may also set this parameter to default_currency in which case users default currency is used.

Return Type

GetPipelineResponse200|error - Get Pipeline

updatePipeline

Isolated FunctionRemote Function

function updatePipeline(int id, Pipelinerequest1 payload) returns UpdatePipelineResponse200|error

Edit a pipeline

Parameters

id int - ID of the pipeline

payload Pipelinerequest1 - Pipeline request

Return Type

UpdatePipelineResponse200|error - Edit Pipeline

deletePipeline

Isolated FunctionRemote Function

function deletePipeline(int id) returns DeletePipelineResponse200|error

Delete a pipeline

Parameters

id int - ID of the pipeline

Return Type

DeletePipelineResponse200|error - Delete Pipeline

getPipelineConversionStatistics

Isolated FunctionRemote Function

function getPipelineConversionStatistics(int id, string startDate, string endDate, int? userId) returns GetPipelineConversionStatisticsResponse200|error

Get deals conversion rates in pipeline

Parameters

id int - ID of the pipeline

startDate string - Start of the period. Date in format of YYYY-MM-DD.

endDate string - End of the period. Date in format of YYYY-MM-DD.

userId int? (default ()) - ID of the user who's pipeline metrics statistics to fetch. If omitted, the authorized user will be used.

Return Type

GetPipelineConversionStatisticsResponse200|error - Get Pipeline Deals conversion rates

getPipelineDeals

Isolated FunctionRemote Function

function getPipelineDeals(int id, int? filterId, int? userId, decimal? everyone, int? stageId, int 'start, int? 'limit, decimal? getSummary, string? totalsConvertCurrency) returns GetStageDealsResponse200|error

Get deals in a pipeline

Parameters

id int - ID of the pipeline

filterId int? (default ()) - If supplied, only deals matching the given filter will be returned.

userId int? (default ()) - If supplied, filter_id will not be considered and only deals owned by the given user will be returned. If omitted, deals owned by the authorized user will be returned.

everyone decimal? (default ()) - If supplied, filter_id and user_id will not be considered – instead, deals owned by everyone will be returned.

stageId int? (default ()) - If supplied, only deals within the given stage will be returned.

'start int (default 0) - Pagination start

'limit int? (default ()) - Items shown per page

getSummary decimal? (default ()) - Whether to include summary of the pipeline in the additional_data or not.

totalsConvertCurrency string? (default ()) - 3-letter currency code of any of the supported currencies. When supplied, per_stages_converted is returned inside deals_summary inside additional_data which contains the currency-converted total amounts in the given currency per each stage. You may also set this parameter to default_currency in which case users default currency is used. Only works when get_summary parameter flag is enabled.

Return Type

GetStageDealsResponse200|error - Get Deals in a Stage

getPipelineMovementStatistics

Isolated FunctionRemote Function

function getPipelineMovementStatistics(int id, string startDate, string endDate, int? userId) returns GetPipelineMovementStatisticsResponse200|error

Get deals movements in pipeline

Parameters

id int - ID of the pipeline

startDate string - Start of the period. Date in format of YYYY-MM-DD.

endDate string - End of the period. Date in format of YYYY-MM-DD.

userId int? (default ()) - ID of the user who's pipeline statistics to fetch. If omitted, the authorized user will be used.

Return Type

GetPipelineMovementStatisticsResponse200|error - Get Pipeline Deals conversion rates

getProducts

Isolated FunctionRemote Function

function getProducts(int? userId, int[]? ids, string? firstChar, boolean? getSummary, int 'start, int? 'limit) returns GetProductsResponse200|error

Get all products

Parameters

userId int? (default ()) - If supplied, only Products owned by the given user will be returned

ids int[]? (default ()) - An array of integers with the IDs of the Products that sould be returned in the response

firstChar string? (default ()) - If supplied, only Products whose name starts with the specified letter will be returned (case insensitive)

getSummary boolean? (default ()) - If supplied, response will return the total numbers of Products in the additional_data.summary.total_count property

'start int (default 0) - Pagination start

'limit int? (default ()) - Items shown per page

Return Type

GetProductsResponse200|error - List of products

addProduct

Isolated FunctionRemote Function

function addProduct(AddProductRequest payload) returns GetproductResponse200|error

Add a product

Parameters

payload AddProductRequest - AddProduct request

Return Type

GetproductResponse200|error - Add Product data

searchProducts

Isolated FunctionRemote Function

function searchProducts(string term, string? fields, boolean? exactMatch, string? includeFields, int 'start, int? 'limit) returns SearchProductsResponse200|error

Search products

Parameters

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

fields string? (default ()) - A comma-separated string array. The fields to perform the search from. Defaults to all of them.

exactMatch boolean? (default ()) - When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.

includeFields string? (default ()) - Supports including optional fields in the results which are not provided by default.

'start int (default 0) - Pagination start. Note that the pagination is based on main results and does not include related items when using search_for_related_items parameter.

'limit int? (default ()) - Items shown per page

Return Type

SearchProductsResponse200|error - success

findProductsByName

DeprecatedIsolated FunctionRemote Function

function findProductsByName(string term, string? currency, int 'start, int? 'limit) returns FindProductsByNameResponse200|error

Find products by name

Parameters

term string - Search term to look for, minimum 3 characters.

currency string? (default ()) - Currency code in which prices should be returned in. If omitted, prices in user's default currency will be returned.

'start int (default 0) - Pagination start

'limit int? (default ()) - Items shown per page

Return Type

FindProductsByNameResponse200|error - Returns data about the Products that were found
Deprecated

getProduct

Isolated FunctionRemote Function

function getProduct(int id) returns GetproductResponse200|error

Get one product

Parameters

id int - ID of the product

Return Type

GetproductResponse200|error - Get product information by id

updateProduct

Isolated FunctionRemote Function

function updateProduct(int id, ProductRequest payload) returns UpdateProductResponse200|error

Update a product

Parameters

id int - ID of the product

payload ProductRequest - Product request

Return Type

UpdateProductResponse200|error - Updates Product data

deleteProduct

Isolated FunctionRemote Function

function deleteProduct(int id) returns DeleteProductResponse200|error

Delete a product

Parameters

id int - ID of the product

Return Type

DeleteProductResponse200|error - Deletes a product

getProductDeals

Isolated FunctionRemote Function

function getProductDeals(int id, int 'start, int? 'limit, string status) returns BasicDeal|error

Get deals where a product is attached to

Parameters

id int - ID of the product

'start int (default 0) - Pagination start

'limit int? (default ()) - Items shown per page

status string (default "all_not_deleted") - Only fetch deals with specific status. If omitted, all not deleted deals are fetched.

Return Type

BasicDeal|error - The data of deals that have a Product attached

getProductFiles

Isolated FunctionRemote Function

function getProductFiles(int id, int 'start, int? 'limit, decimal? includeDeletedFiles, string? sort) returns GetAssociatedFilesResponse200|error

List files attached to a product

Parameters

id int - ID of the product

'start int (default 0) - Pagination start

'limit int? (default ()) - Items shown per page

includeDeletedFiles decimal? (default ()) - When enabled, the list of files will also include deleted files. Please note that trying to download these files will not work.

sort string? (default ()) - Field names and sorting mode separated by a comma (field_name_1 ASC, field_name_2 DESC). Only first-level field keys are supported (no nested keys). Supported fields: id, user_id, deal_id, person_id, org_id, product_id, add_time, update_time, file_name, file_type, file_size, comment.

Return Type

GetAssociatedFilesResponse200|error - success

getProductFollowers

Isolated FunctionRemote Function

function getProductFollowers(int id, int 'start, int? 'limit) returns GetProductFollowersResponseSuccess|error

List followers of a product

Parameters

id int - ID of the product

'start int (default 0) - Pagination start

'limit int? (default ()) - Items shown per page

Return Type

GetProductFollowersResponseSuccess|error - Lists the followers of a Product

addProductFollower

Isolated FunctionRemote Function

function addProductFollower(int id, AddProductFollowerRequest payload) returns NewFollowerResponse200|error

Add a follower to a product

Parameters

id int - ID of the product

payload AddProductFollowerRequest - AddProductFollower request

Return Type

NewFollowerResponse200|error - Adds a follower to a Product

deleteProductFollower

Isolated FunctionRemote Function

function deleteProductFollower(int id, int followerId) returns DeleteProductFollowerResponse200|error

Delete a follower from a product

Parameters

id int - ID of the product

followerId int - ID of the follower

Return Type

DeleteProductFollowerResponse200|error - Deletes a follower from a Product

getProductUsers

Isolated FunctionRemote Function

function getProductUsers(int id) returns UserIds|error

List permitted users

Parameters

id int - ID of the product

Return Type

UserIds|error - Lists users permitted to access a Product

getProductFields

Isolated FunctionRemote Function

function getProductFields() returns GetProductFieldsResponse200|error

Get all product fields

Return Type

GetProductFieldsResponse200|error - Get data about all Product Fields

addProductField

Isolated FunctionRemote Function

function addProductField(ProductfieldsBody payload) returns GetProductFieldResponse200|error

Add a new product field

Parameters

payload ProductfieldsBody - ProductField request

Return Type

GetProductFieldResponse200|error - Get the data for a single Product Field

deleteProductFields

Isolated FunctionRemote Function

function deleteProductFields(string ids) returns DeleteProductFieldsResponse200|error

Delete multiple product fields in bulk

Parameters

ids string - Comma-separated field IDs to delete

Return Type

DeleteProductFieldsResponse200|error - Mark multiple Product Fields as deleted

getProductField

Isolated FunctionRemote Function

function getProductField(int id) returns GetProductFieldResponse200|error

Get one product field

Parameters

id int - ID of the Product Field

Return Type

GetProductFieldResponse200|error - Get the data for a single Product Field

updateProductField

Isolated FunctionRemote Function

function updateProductField(int id, AddOrUpdateProductFieldResponse200 payload) returns GetProductFieldResponse200|error

Update a product field

Parameters

id int - ID of the Product Field

payload AddOrUpdateProductFieldResponse200 - AddOrUpdateProductField request

Return Type

GetProductFieldResponse200|error - Get the data for a single Product Field

deleteProductField

Isolated FunctionRemote Function

function deleteProductField(int id) returns DeleteProductFieldResponse200|error

Delete a product field

Parameters

id int - ID of the Product Field

Return Type

DeleteProductFieldResponse200|error - Delete a Product Field

getRecents

Isolated FunctionRemote Function

function getRecents(string sinceTimestamp, string? items, int 'start, int? 'limit) returns GetRecentsResponse200|error

Get recents

Parameters

sinceTimestamp string - Timestamp in UTC. Format: YYYY-MM-DD HH:MM:SS

items string? (default ()) - Multiple selection of item types to include in query (optional)

'start int (default 0) - Pagination start

'limit int? (default ()) - Items shown per page

Return Type

GetRecentsResponse200|error - List of items changed since "since_timestamp"

getRoles

Isolated FunctionRemote Function

function getRoles(int 'start, int? 'limit) returns GetRolesResponse200|error

Get all roles

Parameters

'start int (default 0) - Pagination start

'limit int? (default ()) - Items shown per page

Return Type

GetRolesResponse200|error - Get all roles

addRole

Isolated FunctionRemote Function

function addRole(AddRoleRequest payload) returns AddRoleResponse200|error

Add a role

Parameters

payload AddRoleRequest - AddRole request

Return Type

AddRoleResponse200|error - Add a role

getRole

Isolated FunctionRemote Function

function getRole(int id) returns GetRoleResponse200|error

Get one role

Parameters

id int - ID of the role

Return Type

GetRoleResponse200|error - Get one role

updateRole

Isolated FunctionRemote Function

function updateRole(int id, BaseRoleRequest payload) returns UpdateRoleResponse200|error

Update role details

Parameters

id int - ID of the role

payload BaseRoleRequest - BaseRole request

Return Type

UpdateRoleResponse200|error - Update role details

deleteRole

Isolated FunctionRemote Function

function deleteRole(int id) returns DeleteRoleResponse200|error

Delete a role

Parameters

id int - ID of the role

Return Type

DeleteRoleResponse200|error - Delete a role

getRoleAssignments

Isolated FunctionRemote Function

function getRoleAssignments(int id, int 'start, int? 'limit) returns GetUserRoleAssignmentsResponse200|error

List role assignments

Parameters

id int - ID of the role

'start int (default 0) - Pagination start

'limit int? (default ()) - Items shown per page

Return Type

GetUserRoleAssignmentsResponse200|error - List assignments for a role

addRoleAssignment

Isolated FunctionRemote Function

function addRoleAssignment(int id, AddRoleAssignmentRequest payload) returns AddRoleAssignmentResponse200|error

Add role assignment

Parameters

id int - ID of the role

payload AddRoleAssignmentRequest - AddRoleAssignment request

Return Type

AddRoleAssignmentResponse200|error - Add assignment for a role

deleteRoleAssignment

Isolated FunctionRemote Function

function deleteRoleAssignment(int id) returns DeleteRoleAssignmentResponse200|error

Delete a role assignment

Parameters

id int - ID of the role

Return Type

DeleteRoleAssignmentResponse200|error - Delete assignment from a role

getRoleSubRoles

Isolated FunctionRemote Function

function getRoleSubRoles(int id, int 'start, int? 'limit) returns GetRoleSubrolesResponse200|error

List role sub-roles

Parameters

id int - ID of the role

'start int (default 0) - Pagination start

'limit int? (default ()) - Items shown per page

Return Type

GetRoleSubrolesResponse200|error - List role sub-roles

getRoleSettings

Isolated FunctionRemote Function

function getRoleSettings(int id) returns GetRoleSettingsResponse200|error

List role settings

Parameters

id int - ID of the role

Return Type

GetRoleSettingsResponse200|error - List role settings

addOrUpdateRoleSetting

Isolated FunctionRemote Function

function addOrUpdateRoleSetting(int id, AddOrUpdateRoleSettingRequest payload) returns AddOrUpdateRoleSettingResponse200|error

Add or update role setting

Parameters

id int - ID of the role

payload AddOrUpdateRoleSettingRequest - AddOrUpdateRoleSetting request

Return Type

AddOrUpdateRoleSettingResponse200|error - List role settings

search

DeprecatedIsolated FunctionRemote Function

function search(string term, string? itemType, int 'start, int? 'limit, decimal? exactMatch) returns json|error

Perform a search

Parameters

term string - Search term to look for, minimum 2 characters.

itemType string? (default ()) - Search for items of exact type. If omitted, all types of items are searched.

'start int (default 0) - Pagination start

'limit int? (default ()) - Items shown per page

exactMatch decimal? (default ()) - When enabled, only full exact matches against the given term are returned. The minimum 2 character limit for the term is discarded when exact_match is enabled. It will only work if search term is 30 characters or less.

Return Type

json|error - success
Deprecated

searchByField

DeprecatedIsolated FunctionRemote Function

function searchByField(string term, string fieldType, string fieldKey, decimal? exactMatch, string? returnFieldKey, decimal? returnItemIds, int 'start, int? 'limit) returns json|error

Perform a search using a specific field value

Parameters

term string - Search term to look for, minimum 2 characters.

fieldType string - Type of the field to perform the search from.

fieldKey string - Key of the field to search from. Field key can be obtained by fetching the list of fields using any of fields API GET methods (dealFields, personFields, ..).

exactMatch decimal? (default ()) - When enabled, only full exact matches against the given term are returned. By default, term can be present anywhere in the resulting field values to be considered a match. The minimum 2 character limit for the term is discarded when exact_match is enabled.

returnFieldKey string? (default ()) - Name of the field in search results from which the search was performed. When omitted, 'value' will be used. You may want to set this parameter to match the field_key.

returnItemIds decimal? (default ()) - Whether to return matching items IDs in search results. When omitted or set to 0, only distinct values of the searched field are returned. When enabled, the return_field_key parameter is ignored and the results include the searched field as its own key.

'start int (default 0) - Pagination start

'limit int? (default ()) - Items shown per page

Return Type

json|error - success
Deprecated

getStages

Isolated FunctionRemote Function

function getStages(int? pipelineId) returns GetStagesResponse200|error

Get all stages

Parameters

pipelineId int? (default ()) - The ID of the pipeline to fetch stages for. If omitted, stages for all pipelines will be fetched.

Return Type

GetStagesResponse200|error - Get all Stages

addStage

Isolated FunctionRemote Function

function addStage(AddStageRequest payload) returns StageResponse200|error

Add a new stage

Parameters

payload AddStageRequest - AddStage request

Return Type

StageResponse200|error - Get all Stages

deleteStages

Isolated FunctionRemote Function

function deleteStages(string ids) returns DeleteStagesResponse200|error

Delete multiple stages in bulk

Parameters

ids string - Comma-separated stage IDs to delete

Return Type

DeleteStagesResponse200|error - Delete multiple Stages

getStage

Isolated FunctionRemote Function

function getStage(int id) returns GetStageResponse200|error

Get one stage

Parameters

id int - ID of the stage

Return Type

GetStageResponse200|error - Get Stage

updateStage

Isolated FunctionRemote Function

function updateStage(int id, UpdateStageRequest payload) returns StageResponse200|error

Update stage details

Parameters

id int - ID of the stage

payload UpdateStageRequest - UpdateStage request

Return Type

StageResponse200|error - Get all Stages

deleteStage

Isolated FunctionRemote Function

function deleteStage(int id) returns DeleteStageResponse200|error

Delete a stage

Parameters

id int - ID of the stage

Return Type

DeleteStageResponse200|error - Delete Stage

getStageDeals

Isolated FunctionRemote Function

function getStageDeals(int id, int? filterId, int? userId, decimal? everyone, int 'start, int? 'limit) returns GetStageDealsResponse200|error

Get deals in a stage

Parameters

id int - ID of the stage

filterId int? (default ()) - If supplied, only deals matching the given filter will be returned.

userId int? (default ()) - If supplied, filter_id will not be considered and only deals owned by the given user will be returned. If omitted, deals owned by the authorized user will be returned.

everyone decimal? (default ()) - If supplied, filter_id and user_id will not be considered – instead, deals owned by everyone will be returned.

'start int (default 0) - Pagination start

'limit int? (default ()) - Items shown per page

Return Type

GetStageDealsResponse200|error - Get Deals in a Stage

getSubscription

Isolated FunctionRemote Function

function getSubscription(int id) returns SubscriptionsIdResponse200|error

Get details of a subscription

Parameters

id int - ID of the Subscription

Return Type

SubscriptionsIdResponse200|error - success

deleteSubscription

Isolated FunctionRemote Function

function deleteSubscription(int id) returns SubscriptionsIdResponse200|error

Delete a subscription

Parameters

id int - ID of the Subscription

Return Type

SubscriptionsIdResponse200|error - success

findSubscriptionByDeal

Isolated FunctionRemote Function

function findSubscriptionByDeal(int dealId) returns SubscriptionsIdResponse200|error

Find subscription by deal

Parameters

dealId int - ID of the Deal

Return Type

SubscriptionsIdResponse200|error - success

getSubscriptionPayments

Isolated FunctionRemote Function

function getSubscriptionPayments(int id) returns PaymentResponse200|error

Get all payments of a Subscription

Parameters

id int - ID of the Subscription

Return Type

PaymentResponse200|error - success

addRecurringSubscription

Isolated FunctionRemote Function

function addRecurringSubscription(AddRecurringSubscriptionRequest payload) returns SubscriptionsIdResponse200|error

Add a recurring subscription

Parameters

payload AddRecurringSubscriptionRequest - AddRecurringSubscription request

Return Type

SubscriptionsIdResponse200|error - success

addSubscriptionInstallment

Isolated FunctionRemote Function

function addSubscriptionInstallment(AddSubscriptionInstallmentRequest payload) returns SubscriptionsIdResponse200|error

Add an installment subscription

Parameters

payload AddSubscriptionInstallmentRequest - AddSubscriptionInstallment request

Return Type

SubscriptionsIdResponse200|error - success

updateRecurringSubscription

Isolated FunctionRemote Function

function updateRecurringSubscription(int id, UpdateRecurringSubscriptionRequest payload) returns SubscriptionsIdResponse200|error

Update a recurring subscription

Parameters

id int - ID of the Subscription

payload UpdateRecurringSubscriptionRequest - UpdateRecurringSubscription request

Return Type

SubscriptionsIdResponse200|error - success

updateSubscriptionInstallment

Isolated FunctionRemote Function

function updateSubscriptionInstallment(int id, UpdateSubscriptionInstallmentRequest payload) returns SubscriptionsIdResponse200|error

Update an installment subscription

Parameters

id int - ID of the Subscription

payload UpdateSubscriptionInstallmentRequest - UpdateSubscriptionInstallment request

Return Type

SubscriptionsIdResponse200|error - success

cancelRecurringSubscription

Isolated FunctionRemote Function

function cancelRecurringSubscription(int id, CancelRecurringSubscriptionRequest payload) returns SubscriptionsIdResponse200|error

Cancel a recurring subscription

Parameters

id int - ID of the Subscription

payload CancelRecurringSubscriptionRequest - CancelRecurringSubscription request

Return Type

SubscriptionsIdResponse200|error - success

getTeams

Isolated FunctionRemote Function

function getTeams(string orderBy, decimal skipUsers) returns TeamsResponse200|error

Get all teams

Parameters

orderBy string (default "id") - Field name to sort returned teams by

skipUsers decimal (default 1) - When enabled, the teams will not include IDs of member users

Return Type

TeamsResponse200|error - The list of team objects

addTeam

Isolated FunctionRemote Function

function addTeam(AddTeamRequest payload) returns TeamResponse200|error

Add a new team

Parameters

payload AddTeamRequest - AddTeam request

Return Type

TeamResponse200|error - The team data

getTeam

Isolated FunctionRemote Function

function getTeam(int id, decimal skipUsers) returns TeamResponse200|error

Get a single team

Parameters

id int - ID of the team

skipUsers decimal (default 1) - When enabled, the teams will not include IDs of member users

Return Type

TeamResponse200|error - The team data

updateTeam

Isolated FunctionRemote Function

function updateTeam(int id, UpdateTeamRequest payload) returns TeamResponse200|error

Update a team

Parameters

id int - ID of the team

payload UpdateTeamRequest - UpdateTeam request

Return Type

TeamResponse200|error - The team data

getTeamUsers

Isolated FunctionRemote Function

function getTeamUsers(int id) returns UserIds|error

Get all users in a team

Parameters

id int - ID of the team

Return Type

UserIds|error - A list of user IDs within a team

addTeamUser

Isolated FunctionRemote Function

function addTeamUser(int id, AddTeamUserRequest payload) returns UserIds|error

Add users to a team

Parameters

id int - ID of the team

payload AddTeamUserRequest - AddTeamUser request

Return Type

UserIds|error - A list of user IDs within a team

deleteTeamUser

Isolated FunctionRemote Function

function deleteTeamUser(int id) returns UserIds|error

Delete users from a team

Parameters

id int - ID of the team

Return Type

UserIds|error - A list of user IDs within a team

getUserTeams

Isolated FunctionRemote Function

function getUserTeams(int id, string orderBy, decimal skipUsers) returns TeamsResponse200|error

Get all teams of a user

Parameters

id int - ID of the user

orderBy string (default "id") - Field name to sort returned teams by

skipUsers decimal (default 1) - When enabled, the teams will not include IDs of member users

Return Type

TeamsResponse200|error - The list of team objects

getUsers

Isolated FunctionRemote Function

function getUsers() returns UsersResponse200|error

Get all users

Return Type

UsersResponse200|error - The list of user objects

addUser

Isolated FunctionRemote Function

function addUser(AddUserRequest payload) returns UserResponse200|error

Add a new user

Parameters

payload AddUserRequest - AddUser request

Return Type

UserResponse200|error - The data of the User

findUsersByName

Isolated FunctionRemote Function

function findUsersByName(string term, decimal searchByEmail) returns UsersResponse200|error

Find users by name

Parameters

term string - Search term to look for

searchByEmail decimal (default 1) - When enabled, term will only be matched against email addresses of users. Default: false

Return Type

UsersResponse200|error - The list of user objects

getCurrentUser

Isolated FunctionRemote Function

function getCurrentUser() returns GetCurrentUserResponse200|error

Get current user data

Return Type

GetCurrentUserResponse200|error - The data of the logged in user

getUser

Isolated FunctionRemote Function

function getUser(int id) returns UserResponse200|error

Get one user

Parameters

id int - ID of the user

Return Type

UserResponse200|error - The data of the User

updateUser

Isolated FunctionRemote Function

function updateUser(int id, UpdateUserRequest payload) returns UserResponse200|error

Update user details

Parameters

id int - ID of the user

payload UpdateUserRequest - UpdateUser request

Return Type

UserResponse200|error - The data of the User

getUserFollowers

Isolated FunctionRemote Function

function getUserFollowers(int id) returns UserIds|error

List followers of a user

Parameters

id int - ID of the user

Return Type

UserIds|error - The list of user IDs

getUserPermissions

Isolated FunctionRemote Function

function getUserPermissions(int id) returns GetUserPermissionsResponse200|error

List user permissions

Parameters

id int - ID of the user

Return Type

GetUserPermissionsResponse200|error - The list of User permissions

getUserRoleAssignments

Isolated FunctionRemote Function

function getUserRoleAssignments(int id, int 'start, int? 'limit) returns GetUserRoleAssignmentsResponse200|error

List role assignments

Parameters

id int - ID of the user

'start int (default 0) - Pagination start

'limit int? (default ()) - Items shown per page

Return Type

GetUserRoleAssignmentsResponse200|error - List assignments for a role

addUserRoleAssignment

Isolated FunctionRemote Function

function addUserRoleAssignment(int id, AddUserRoleAssignmentRequest payload) returns AddRoleAssignmentResponse200|error

Add role assignment

Parameters

id int - ID of the user

payload AddUserRoleAssignmentRequest - AddUserRoleAssignment request

Return Type

AddRoleAssignmentResponse200|error - Add assignment for a role

deleteUserRoleAssignment

Isolated FunctionRemote Function

function deleteUserRoleAssignment(int id) returns DeleteRoleAssignmentResponse200|error

Delete a role assignment

Parameters

id int - ID of the user

Return Type

DeleteRoleAssignmentResponse200|error - Delete assignment from a role

getUserRoleSettings

Isolated FunctionRemote Function

function getUserRoleSettings(int id) returns GetRoleSettingsResponse200|error

List user role settings

Parameters

id int - ID of the user

Return Type

GetRoleSettingsResponse200|error - List role settings

getUserConnections

Isolated FunctionRemote Function

function getUserConnections() returns UserConnectionsResponse200|error

Get all user connections

Return Type

UserConnectionsResponse200|error - The data of user connections

getUserSettings

Isolated FunctionRemote Function

function getUserSettings() returns GetUserSettingsResponse200|error

List settings of an authorized user

Return Type

GetUserSettingsResponse200|error - The list of user settings

getWebhooks

Isolated FunctionRemote Function

function getWebhooks() returns GetWebhooksResponse200|error

Get all webhooks

Return Type

GetWebhooksResponse200|error - The list of webhooks objects from the logged in company and user

addWebhook

Isolated FunctionRemote Function

function addWebhook(AddWebhookRequest payload) returns WebhookResponse200|error

Create a new webhook

Parameters

payload AddWebhookRequest - AddWebhook request

Return Type

WebhookResponse200|error - The created webhook object

deleteWebhook

Isolated FunctionRemote Function

function deleteWebhook(int id) returns BaseResponse200|error

Delete existing webhook

Parameters

id int - The ID of the webhook to delete

Return Type

BaseResponse200|error - The webhook deletion success response

Records

pipedrive: ActivityDistributionDataWithAdditionalData

Fields

Fields Included from *ActivityDistributionDataWithAdditionalData1

activity_distribution Activitydistributiondatawithadditionaldata1ActivityDistribution|()
anydata...

Fields Included from *ActivityDistributionDataWithAdditionalData2

start int|()
limit int|()
more_items_in_collection boolean|()
anydata...

pipedrive: ActivityDistributionDataWithAdditionalData1

Fields

activity_distribution Activitydistributiondatawithadditionaldata1ActivityDistribution? - The distribution of Activities related to the Organization grouped by the User ID

pipedrive: Activitydistributiondatawithadditionaldata1ActivityDistribution

The distribution of Activities related to the Organization grouped by the User ID

Fields

ASSIGNED_TO_USER_ID Activitydistributiondatawithadditionaldata1ActivityDistributionAssignedToUserId? - The ID of the User

pipedrive: Activitydistributiondatawithadditionaldata1ActivityDistributionAssignedToUserId

The ID of the User

Fields

activities Activitydistributiondatawithadditionaldata1ActivityDistributionAssignedToUserIdActivities? - The count of Activities related to the User grouped by Activity type

name string? - The name of the User

activity_count int? - The overall count of Activities for the User

pipedrive: Activitydistributiondatawithadditionaldata1ActivityDistributionAssignedToUserIdActivities

The count of Activities related to the User grouped by Activity type

Fields

ACTIVITY_TYPE_NAME int? - The count of Activities related to a specific type

pipedrive: ActivityDistributionDataWithAdditionalData2

The additional data of the list

Fields

'start int? - Pagination start

'limit int? - Items shown per page

more_items_in_collection boolean? - If there are more list items in the collection than displayed or not

pipedrive: ActivityResponseObject1

Fields

due_date string? - Due date of the Activity. Format: YYYY-MM-DD

due_time string? - Due time of the Activity in UTC. Format: HH:MM

duration string? - Duration of the Activity. Format: HH:MM

deal_id int? - The ID of the Deal this Activity is associated with

person_id int? - The ID of the Person this Activity is associated with

org_id int? - The ID of the Organization this Activity is associated with

note string? - Note of the Activity (HTML format)

location string? - The address of the Activity. Pipedrive will automatically check if the location matches a geo-location on Google maps.

public_description string? - Additional details about the Activity that is synced to your external calendar. Unlike the note added to the Activity, the description is publicly visible to any guests added to the Activity.

pipedrive: ActivityResponseObject2

Fields

id int? - The Activity ID, generated when the Activity was created

done boolean? - Whether the Activity is done or not

subject string? - Subject of the Activity

'type string? - Type of the Activity. This is in correlation with the key_string parameter of ActivityTypes.

user_id int? - The ID of the User whom the Activity is assigned to

participants record {}[]? - List of multiple Persons (participants) this Activity is associated with

busy_flag boolean? - Marks if the Activity is set as 'Busy' or 'Free'. If the flag is set to true, your customers will not be able to book that time slot through any Scheduler links. The flag can also be unset. When the value of the flag is unset (null), the flag defaults to 'Busy' if it has a time set, and 'Free' if it is an all-day event without specified time.

attendees record {}[]? - Attendees of the Activity. This can be either your existing Pipedrive contacts or an external email address.

company_id int? - The User's company ID

reference_type string? - If the Activity references some other object, it is indicated here. For example, value Salesphone refers to Activities created with Caller.

reference_id int? - Together with the reference_type, gives the ID of the other object

conference_meeting_client string? - The ID of Marketplace app, which is connected to this Activity

conference_meeting_url string? - The link to join the meeting which is associated with this Activity

conference_meeting_id string? - The meeting ID of the meeting provider (Zoom, MS Teams etc.) that is associated with this Activity

add_time string? - The creation date and time of the Activity in UTC. Format: YYYY-MM-DD HH:MM:SS.

marked_as_done_time string? - The date and time this Activity was marked as done. Format: YYYY-MM-DD HH:MM:SS.

last_notification_time string? - The date and time of latest notifications sent about this Activity to the participants or the attendees of this Activity

last_notification_user_id int? - The ID of the User who triggered the sending of the latest notifications about this Activity to the participants or the attendees of this Activity

notification_language_id int? - The ID of the language the notifications are sent in

lead_id string? - The ID of the Lead in the UUID format this Activity is associated with

active_flag boolean? - Whether the Activity is active or not

update_time string? - The last update date and time of the Activity. Format: YYYY-MM-DD HH:MM:SS.

update_user_id int? - The ID of the User who was the last to update this Activity

gcal_event_id string? - For the Activity which syncs to Google calendar, this is the Google event ID. NB! This field is related to old Google calendar sync and will be deprecated soon.

google_calendar_id string? - The Google calendar ID that this Activity syncs to. NB! This field is related to old Google calendar sync and will be deprecated soon.

google_calendar_etag string? - The Google calendar API etag (version) that is used for syncing this Activity. NB! This field is related to old Google calendar sync and will be deprecated soon.

calendar_sync_include_context string? - For Activities that sync to an external calendar, this setting indicates if the Activity syncs with context (what are the Deals, Persons, Organizations this Activity is related to)

source_timezone string? - The timezone the Activity was created in an external calendar

rec_rule string? - The rule for the recurrence of the Activity. Is important for activities synced into Pipedrive from an external calendar. Example: "RRULE:FREQ=WEEKLY;BYDAY=WE"

rec_rule_extension string? - Additional rules for the recurrence of the Activity, extend the rec_rule. Is important for activities synced into Pipedrive from an external calendar.

rec_master_activity_id int? - The ID of parent Activity for a recurrent Activity if the current Activity is an exception to recurrence rules

series record {}[]? - The list of recurring Activity instances. It is in a structure as follows: [{due_date: "2020-06-24", due_time: "10:00:00"}]

created_by_user_id int? - The ID of the User who created the Activity

location_subpremise string? - Subfield of location field. Indicates apartment/suite number.

location_street_number string? - Subfield of location field. Indicates house number.

location_route string? - Subfield of location field. Indicates street name.

location_sublocality string? - Subfield of location field. Indicates district/sublocality.

location_locality string? - Subfield of location field. Indicates city/town/village/locality.

location_admin_area_level_1 string? - Subfield of location field. Indicates state/county.

location_admin_area_level_2 string? - Subfield of location field. Indicates region.

location_country string? - Subfield of location field. Indicates country.

location_postal_code string? - Subfield of location field. Indicates ZIP/postal code.

location_formatted_address string? - Subfield of location field. Indicates full/combined address.

location_lat decimal? - Subfield of location field. Indicates latitude.

location_long decimal? - Subfield of location field. Indicates longitude.

org_name string? - Name of the Organization this Activity is associated with

person_name string? - Name of the Person this Activity is associated with

deal_title string? - Name of the Deal this Activity is associated with

owner_name string? - Name of the User this Activity is owned by

person_dropbox_bcc string? - The bcc email address of the Person

deal_dropbox_bcc string? - The bcc email address of the Deal

assigned_to_user_id int? - The ID of the User to whom the Activity is assigned to. Equal to user_id.

file record {}? - The file that is attached to this Activity. For example, this can be a reference to an audio note file generated with Pipedrive mobile app.

pipedrive: ActivityResponseObjectData

Fields

Fields Included from *ActivityResponseObject1

due_date string|()
due_time string|()
duration string|()
deal_id int|()
person_id int|()
org_id int|()
note string|()
location string|()
public_description string|()
anydata...

Fields Included from *ActivityResponseObject2

id int|()
done boolean|()
subject string|()
type string|()
user_id int|()
participants record { anydata... }[]|()
busy_flag boolean|()
attendees record { anydata... }[]|()
company_id int|()
reference_type string|()
reference_id int|()
conference_meeting_client string|()
conference_meeting_url string|()
conference_meeting_id string|()
add_time string|()
marked_as_done_time string|()
last_notification_time string|()
last_notification_user_id int|()
notification_language_id int|()
lead_id string|()
active_flag boolean|()
update_time string|()
update_user_id int|()
gcal_event_id string|()
google_calendar_id string|()
google_calendar_etag string|()
calendar_sync_include_context string|()
source_timezone string|()
rec_rule string|()
rec_rule_extension string|()
rec_master_activity_id int|()
series record { anydata... }[]|()
created_by_user_id int|()
location_subpremise string|()
location_street_number string|()
location_route string|()
location_sublocality string|()
location_locality string|()
location_admin_area_level_1 string|()
location_admin_area_level_2 string|()
location_country string|()
location_postal_code string|()
location_formatted_address string|()
location_lat decimal|()
location_long decimal|()
org_name string|()
person_name string|()
deal_title string|()
owner_name string|()
person_dropbox_bcc string|()
deal_dropbox_bcc string|()
assigned_to_user_id int|()
file record { anydata... }
anydata...

pipedrive: AddActivityRequest

Fields

due_date string? - Due date of the Activity. Format: YYYY-MM-DD

due_time string? - Due time of the Activity in UTC. Format: HH:MM

duration string? - Duration of the Activity. Format: HH:MM

deal_id int? - The ID of the Deal this Activity is associated with

person_id int? - The ID of the Person this Activity is associated with

org_id int? - The ID of the Organization this Activity is associated with

note string? - Note of the Activity (HTML format)

location string? - The address of the Activity. Pipedrive will automatically check if the location matches a geo-location on Google maps.

public_description string? - Additional details about the Activity that is synced to your external calendar. Unlike the note added to the Activity, the description is publicly visible to any guests added to the Activity.

subject string? - Subject of the Activity. When value for subject is not set, it will be given a default value Call.

'type string? - Type of the Activity. This is in correlation with the key_string parameter of ActivityTypes. When value for type is not set, it will be given a default value Call.

user_id int? - The ID of the User whom the Activity is assigned to. If omitted, the Activity is assigned to the authorized User.

participants record {}[]? - List of multiple Persons (participants) this Activity is associated with. If omitted, single participant from person_id field is used. It requires a structure as follows: [{"person_id":1,"primary_flag":true}]

busy_flag boolean? - Set the Activity as 'Busy' or 'Free'. If the flag is set to true, your customers will not be able to book that time slot through any Scheduler links. The flag can also be unset by never setting it or overriding it with null. When the value of the flag is unset (null), the flag defaults to 'Busy' if it has a time set, and 'Free' if it is an all-day event without specified time.

attendees record {}[]? - Attendees of the Activity. This can be either your existing Pipedrive contacts or an external email address. It requires a structure as follows: [{"email_address":"mail@example.org"}] or [{"person_id":1, "email_address":"mail@example.org"}]

done record {}? - Whether the Activity is done or not. 0 = Not done, 1 = Done

pipedrive: AddActivityResponse200

Fields

success boolean? -

data ActivityResponseObjectData? -

additional_data Addactivityresponse200AdditionalData? -

related_objects Addactivityresponse200RelatedObjects? -

pipedrive: Addactivityresponse200AdditionalData

Fields

updates_story_id int? - This field will be deprecated

pipedrive: Addactivityresponse200RelatedObjects

Fields

user Getactivitiesresponse200RelatedObjectsUser? -

deal Getactivitiesresponse200RelatedObjectsDeal? -

person Addactivityresponse200RelatedObjectsPerson? -

organization Addactivityresponse200RelatedObjectsOrganization? -

pipedrive: Addactivityresponse200RelatedObjectsOrganization

Fields

ORGANIZATION_ID record { active_flag boolean?, id int?, name string?, people_count int?, owner_id int?, address string?, cc_email string? }? - The ID of the Organization associated with the item

pipedrive: Addactivityresponse200RelatedObjectsPerson

Fields

PERSON_ID record { active_flag boolean?, id int?, name string?, email record { label string?, value string?, primary boolean? }[]?, phone record { label string?, value string?, primary boolean? }[]?, owner_id int? }? - The ID of the Person associated with the item

pipedrive: AddActivityTypeRequest

Fields

name string - The name of the ActivityType

icon_key string - Icon graphic to use for representing this activity type.

color string? - A designated color for the ActivityType in 6-character HEX format (e.g. FFFFFF for white, 000000 for black)

pipedrive: AddCallLogRequest

Fields

user_id int? - The ID of the owner of the call log

activity_id int? - If specified, this activity will be converted into a call log, with the information provided. When this field is used, you don't need to specify deal_id, person_id or org_id, as they will be ignored in favor of the values already available in the activity.

subject string? - Name of the activity this call is attached to

duration string? - Call duration in seconds

outcome string - Describes the outcome of the call

from_phone_number string? - The number that made the call

to_phone_number string - The number called

start_time string - The date and time of the start of the call in UTC. Format: YYYY-MM-DD HH:MM:SS.

end_time string - The date and time of the end of the call in UTC. Format: YYYY-MM-DD HH:MM:SS.

person_id int? - The ID of the Person this call is associated with

org_id int? - The ID of the Organization this call is associated with

deal_id int? - The ID of the Deal this call is associated with

note string? - Note for the call log in HTML format

pipedrive: AddCallLogResponse200

Fields

success boolean? - If the response is successful or not

data ResponseCallLogObject? -

pipedrive: AddDealFollowerRequest

Fields

user_id int - ID of the user

pipedrive: AddDealFollowerResponse200

Fields

success boolean? - If the response is successful or not

data Adddealfollowerresponse200Data? -

pipedrive: Adddealfollowerresponse200Data

Fields

user_id int? - The User ID who added the Follower

id int? - The Follower ID

deal_id int? - The ID of the Deal which the Follower was added to

add_time string? - The date and time when the Deal Follower was added

pipedrive: AddDealParticipantRequest

Fields

person_id int - ID of the person

pipedrive: AddDealParticipantResponse200

Fields

success boolean? - If the request was successful or not

data PersonItem? - The object of Participant

related_objects Getdealsresponse200RelatedObjects? -

pipedrive: AddDealProductRequest

Fields

item_price decimal? - Price at which this product will be added to the deal

quantity int? - Quantity – e.g. how many items of this product will be added to the deal

discount_percentage decimal? - Discount %. If omitted, will be set to 0

duration decimal? - Duration of the product (when product durations are not enabled for the company or if omitted, defaults to 1)

product_variation_id int? - ID of the product variation to use. When omitted, no variation will be used.

comments string? - Any textual comment associated with this product-deal attachment. Visible and editable in the application UI.

enabled_flag record {}? - Whether the product is enabled on the deal or not. This makes it possible to add products to a deal with specific price and discount criteria - but keep them disabled, which refrains them from being included in deal price calculation. When omitted, the product will be marked as enabled by default.

product_id int - ID of the product that will be attached

pipedrive: AddDealRequest

Fields

title string? - Deal title

value string? - Value of the deal. If omitted, value will be set to 0.

currency string? - Currency of the deal. Accepts a 3-character currency code. If omitted, currency will be set to the default currency of the authorized user.

user_id int? - ID of the user who will be marked as the owner of this deal. If omitted, the authorized user ID will be used.

person_id int? - ID of the person this deal will be associated with

org_id int? - ID of the organization this deal will be associated with

stage_id int? - ID of the stage this deal will be placed in a pipeline (note that you can't supply the ID of the pipeline as this will be assigned automatically based on stage_id). If omitted, the deal will be placed in the first stage of the default pipeline.

status string? - open = Open, won = Won, lost = Lost, deleted = Deleted. If omitted, status will be set to open.

expected_close_date string? - The expected close date of the Deal. In ISO 8601 format: YYYY-MM-DD.

probability decimal? - Deal success probability percentage. Used/shown only when deal_probability for the pipeline of the deal is enabled.

lost_reason string? - Optional message about why the deal was lost (to be used when status=lost)

visible_to record {}? - Visibility of the deal. If omitted, visibility will be set to the default visibility setting of this item type for the authorized user.<table><tr><th>Value</th><th>Description</th></tr><tr><td>1</td><td>Owner & followers (private)</td></tr><tr><td>3</td><td>Entire company (shared)</td></tr></table>

add_time string? - Optional creation date & time of the deal in UTC. Requires admin user API token. Format: YYYY-MM-DD HH:MM:SS

pipedrive: AddFileAndLinkItRequest

Fields

file_type string - The file type

title string - The title of the file

item_type string - The item type

item_id int - ID of the item to associate the file with

remote_location string - The location type to send the file to. Only googledrive is supported at the moment.

pipedrive: AddFileAndLinkItResponse200

Fields

success boolean? - If the request was successful or not

data Getassociatedfilesresponse200Data? - The File data

pipedrive: AddFilterRequest

Fields

name string - The name of the filter

conditions record {} - The conditions of the filter as a JSON object. It requires a minimum structure as follows: {"glue":"and","conditions":[{"glue":"and","conditions": [CONDITION_OBJECTS]},{"glue":"or","conditions":[CONDITION_OBJECTS]}]}. Replace CONDITION_OBJECTS with JSON objects of the following structure: {"object":"","field_id":"", "operator":"","value":"", "extra_value":""} or leave the array empty. Depending on the object type you should use another API endpoint to get field_id. There are five types of objects you can choose from: "person", "deal", "organization", "product", "activity" and you can use these types of operators depending on what type of a field you have: "IS NOT NULL", "IS NULL", "<=", ">=", "<", ">", "!=", "=", "LIKE '%$%'", "NOT LIKE '%$%'", "LIKE '$%'", "NOT LIKE '$%'", "LIKE '%$'", "NOT LIKE '%$'". To get a better understanding of how filters work try creating them directly from the Pipedrive application.

'type record {} - The type of filter to create

pipedrive: AddGoalRequest

Fields

title string? - Title of the goal.

assignee record {}? - Who is this goal assigned to. It requires the following JSON structure: { "id": "1", "type": "person" }. type can be either person, company or team. ID of the assignee person, company or team.

'type record {}? - Type of the goal. It requires the following JSON structure: { "name": "deals_started", "params": { "pipeline_id": 1 } }. Type can be one of: deals_won, deals_progressed, activities_completed, activities_added, deals_started or revenue_forecast. params can include pipeline_id, stage_id or activity_type_id. stage_id is related to only deals_progressed type of goals and activity_type_id to activities_completed or activities_added types of goals. To track goal in all pipelines set pipeline_id as null.

expected_outcome record {}? - Expected outcome of the goal. Expected outcome can be tracked either by quantity or by sum. It requires the following JSON structure: { "target": "50", "tracking_metric": "quantity" } or { "target": "50", "tracking_metric": "sum", "currency_id": 1 }. currency_id should only be added to sum type of goals.

duration record {}? - Date when the goal starts and ends. It requires the following JSON structure: { "start": "2019-01-01", "end": "2022-12-31" }. Date in format of YYYY-MM-DD. "end" can be set to null for an infinite, open-ended goal.

interval string? - Interval of the goal

pipedrive: AdditionalBaseOrganizationItemInfo

Fields

Fields Included from *OrganizationCountAndAddressInfo

email_messages_count int|()
people_count int|()
activities_count int|()
done_activities_count int|()
undone_activities_count int|()
files_count int|()
notes_count int|()
followers_count int|()
address string|()
address_subpremise string|()
address_street_number string|()
address_route string|()
address_sublocality string|()
address_locality string|()
address_admin_area_level_1 string|()
address_admin_area_level_2 string|()
address_country string|()
address_postal_code string|()
address_formatted_address string|()
anydata...

Fields Included from *DealsCountAndActivityInfo

open_deals_count int|()
related_open_deals_count int|()
closed_deals_count int|()
related_closed_deals_count int|()
won_deals_count int|()
related_won_deals_count int|()
lost_deals_count int|()
related_lost_deals_count int|()
next_activity_date string|()
next_activity_time string|()
next_activity_id int|()
last_activity_id int|()
last_activity_date string|()
anydata...

pipedrive: AdditionalData1

Fields

products_quantity_total int? - Total quantity of the Products

products_sum_total int? - Total sum of the Products

variations_enabled boolean? - Is variations enabled or not

products_quantity_total_formatted string? - Total formatted quantity of the Products

products_sum_total_formatted string? - Total formatted sum of the Products

pipedrive: AdditionalData2

Fields

pagination Additionaldata2Pagination? - Pagination details of the list

pipedrive: Additionaldata2Pagination

Pagination details of the list

Fields

'start int? - Pagination start

'limit int? - Items shown per page

more_items_in_collection boolean? - Whether there are more list items in the collection than displayed

next_start int? - Next pagination start

pipedrive: AdditionalPersonInfo

Fields

Fields Included from *PersonNameInfoWithOrgAndOwnerId

owner_id record { id int|(), name string|(), email string|(), has_pic int|(), pic_hash string|(), active_flag boolean|(), value int|(), anydata... }
org_id record { name string|(), people_count int|(), owner_id int|(), address string|(), cc_email string|(), value int|(), active_flag boolean|(), anydata... }
name string|()
first_name string|()
last_name string|()
anydata...

Fields Included from *PersonCountEmailDealAndActivityInfo

email_messages_count int|()
activities_count int|()
done_activities_count int|()
undone_activities_count int|()
files_count int|()
notes_count int|()
followers_count int|()
last_incoming_mail_time string|()
last_outgoing_mail_time string|()
open_deals_count int|()
related_open_deals_count int|()
closed_deals_count int|()
related_closed_deals_count int|()
won_deals_count int|()
related_won_deals_count int|()
lost_deals_count int|()
related_lost_deals_count int|()
next_activity_date string|()
next_activity_time string|()
next_activity_id int|()
last_activity_id int|()
last_activity_date string|()
anydata...

pipedrive: AddLeadLabelRequest

Fields

name string - The name of the Lead Label

color string - The color of the label. Only a subset of colors can be used.

pipedrive: AddLeadRequest

Fields

title string - The name of the Lead

owner_id int? - The ID of the User which will be the owner of the created Lead. If not provided, the user making the request will be used.

label_ids string[]? - The IDs of the Lead Labels which will be associated with the Lead

person_id int? - The ID of a Person which this Lead will be linked to. If the Person does not exist yet, it needs to be created first. This property is required unless organization_id is specified.

organization_id int? - The ID of an Organization which this Lead will be linked to. If the Organization does not exist yet, it needs to be created first. This property is required unless person_id is specified.

value LeadsValue? - The potential value of the Lead.

expected_close_date string? - The date of when the Deal which will be created from the Lead is expected to be closed. In ISO 8601 format: YYYY-MM-DD.

visible_to record {}? - Visibility of the Lead. If omitted, visibility will be set to the default visibility setting of this item type for the authorized user.<table><tr><th>Value</th><th>Description</th></tr><tr><td>1</td><td>Owner & followers (private)</td></tr><tr><td>3</td><td>Entire company (shared)</td></tr></table>

was_seen boolean? - A flag indicating whether the Lead was seen by someone in the Pipedrive UI

pipedrive: AddOrganizationFollowerRequest

Fields

user_id int - The ID of the user

pipedrive: AddOrganizationFollowerResponse200

Fields

success boolean? - If the request was successful or not

data OrganizationFollower? -

pipedrive: AddOrganizationRelationshipRequest

Fields

org_id int? - ID of the base organization for the returned calculated values

'type string? - The type of organization relationship

rel_owner_org_id int? - The owner of this relationship. If type is parent, then the owner is the parent and the linked organization is the daughter.

rel_linked_org_id int? - The linked organization in this relationship. If type is parent, then the linked organization is the daughter.

pipedrive: AddOrganizationRelationshipResponse200

Fields

success boolean? - If the response is successful or not

data Addorganizationrelationshipresponse200Data? -

related_objects Getorganizationrelationshipsresponse200RelatedObjects? -

pipedrive: Addorganizationrelationshipresponse200Data

Fields

id int? - The ID of the Organization Relationship

'type string? - The type of the Relationship

rel_owner_org_id record {}? -

rel_linked_org_id record {}? -

add_time string? - The creation date and time of the Relationship

update_time string? - The last updated date and time of the Relationship

active_flag string? - If the Relationship is active or not

pipedrive: AddOrganizationRequest

Fields

name string? - Organization name

owner_id int? - The ID of the user who will be marked as the owner of this Organization. When omitted, the authorized User ID will be used.

visible_to record {}? - Visibility of the organization. If omitted, visibility will be set to the default visibility setting of this item type for the authorized user.<table><tr><th>Value</th><th>Description</th></tr><tr><td>1</td><td>Owner & followers (private)</td></tr><tr><td>3</td><td>Entire company (shared)</td></tr></table>

add_time string? - Optional creation date & time of the organization in UTC. Requires admin user API token. Format: YYYY-MM-DD HH:MM:SS

pipedrive: AddOrganizationResponse200

Fields

success boolean? - If the response is successful or not

data BaseOrganizationItemWithEditNameFlagData? -

related_objects Getorganizationsresponse200RelatedObjects? -

pipedrive: AddOrUpdateGoalResponse200

Fields

success boolean? - If the request was successful or not

data Addorupdategoalresponse200Data? -

pipedrive: Addorupdategoalresponse200Data

Fields

goal Addorupdategoalresponse200DataGoal? -

pipedrive: Addorupdategoalresponse200DataGoal

Fields

id string? - ID of the goal

owner_id string? - ID of the creator of the goal

title string? - The title of the goal

'type GoalType? - Type of the goal

assignee GoalAssignee? - Who is the goal assigned to

interval string? - Interval of the goal

duration GoalDuration? - Duration of the goal

expected_outcome GoalExpectedOutcome? - Expected outcome of the goal

is_active boolean? - If the goal is currently active or not

report_ids int[]? - The IDs of the reports that belong to the goal

pipedrive: AddOrUpdateLeadLabelResponse200

Fields

success boolean? -

data Getleadlabelsresponse200Data? -

pipedrive: AddOrUpdateProductFieldResponse200

Fields

name string - Name of the field

options record {}[]? - When field_type is either set or enum, possible options on update must be supplied as an array of objects each containing id and label, for example: [{"id":1, "label":"red"},{"id":2, "label":"blue"},{"id":3, "label":"lilac"}]

pipedrive: AddOrUpdateRoleSettingRequest

Fields

setting_key string -

value decimal - Possible values for default_visibility settings: 1, 3, 5 or 7

pipedrive: AddOrUpdateRoleSettingResponse200

Fields

success boolean? - If the response is successful or not

data Addorupdaterolesettingresponse200Data? - The response data

pipedrive: Addorupdaterolesettingresponse200Data

The response data

Fields

id int? - The ID of the Role

deal_default_visibility decimal? - The setting

pipedrive: AddPersonFollowerRequest

Fields

user_id int - ID of the user

pipedrive: AddPersonFollowerResponse200

Fields

success boolean? - If the response is successful or not

data Addpersonfollowerresponse200Data? -

pipedrive: Addpersonfollowerresponse200Data

Fields

user_id int? - The ID of the User who was added as a follower to a Person

id int? - The ID of the Follower

person_id int? - The ID of the Person to whom the follower was added

add_time string? - The date and time when the Follower was added to a Person. Format: YYYY-MM-DD HH:MM:SS

pipedrive: AddPersonRequest

Fields

name string? - Person name

owner_id int? - ID of the user who will be marked as the owner of this person. When omitted, the authorized user ID will be used.

org_id int? - ID of the organization this person will belong to.

email string[]? - Email addresses (one or more) associated with the person, presented in the same manner as received by GET request of a person.

phone string[]? - Phone numbers (one or more) associated with the person, presented in the same manner as received by GET request of a person.

visible_to record {}? - Visibility of the person. If omitted, visibility will be set to the default visibility setting of this item type for the authorized user.<table><tr><th>Value</th><th>Description</th></tr><tr><td>1</td><td>Owner & followers (private)</td></tr><tr><td>3</td><td>Entire company (shared)</td></tr></table>

add_time string? - Optional creation date & time of the person in UTC. Requires admin user API token. Format: YYYY-MM-DD HH:MM:SS

pipedrive: AddPersonResponse200

Fields

success boolean? - If the response is successful or not

data record { id int?, company_id int?, active_flag boolean?, phone record { value string?, primary boolean?, label string? }[]?, email record { value string?, primary boolean?, label string? }[]?, first_char string?, add_time string?, update_time string?, visible_to string?, picture_id record { id int?, item_type string?, item_id int?, active_flag boolean?, add_time string?, update_time string?, added_by_user_id int?, pictures record { '128 string?, '512 string? } }, label int?, org_name string?, owner_name string?, cc_email string?, owner_id record { id int?, name string?, email string?, has_pic int?, pic_hash string?, active_flag boolean?, value int? }, org_id record { name string?, people_count int?, owner_id int?, address string?, cc_email string?, value int?, active_flag boolean? }, name string?, first_name string?, last_name string?, email_messages_count int?, activities_count int?, done_activities_count int?, undone_activities_count int?, files_count int?, notes_count int?, followers_count int?, last_incoming_mail_time string?, last_outgoing_mail_time string?, open_deals_count int?, related_open_deals_count int?, closed_deals_count int?, related_closed_deals_count int?, won_deals_count int?, related_won_deals_count int?, lost_deals_count int?, related_lost_deals_count int?, next_activity_date string?, next_activity_time string?, next_activity_id int?, last_activity_id int?, last_activity_date string? }? -

related_objects Listproductsresponse200RelatedObjects? -

pipedrive: AddPipelineResponse200

Fields

success boolean? - If the response is successful or not

data Addpipelineresponse200Data? - The Pipeline object

pipedrive: Addpipelineresponse200Data

The Pipeline object

Fields

id int? - The ID of the Pipeline

name string? - The name of the Pipeline

url_title string? - The Pipeline title displayed in the URL

order_nr int? - Defines the order of Pipelines. First order (order_nr=0) is the default Pipeline.

active boolean? - Whether this Pipeline will be made inactive (hidden) or active

deal_probability boolean? - Whether Deal probability is disabled or enabled for this Pipeline

add_time string? - The Pipeline creation time. Format: YYYY-MM-DD HH:MM:SS.

update_time string? - The Pipeline update time. Format: YYYY-MM-DD HH:MM:SS.

pipedrive: AddProductFollowerRequest

Fields

user_id int - ID of the user

pipedrive: AddProductRequest

Fields

name string? - Name of the product.

code string? - Product code.

unit string? - Unit in which this product is sold

tax decimal? - Tax percentage

active_flag decimal? - Whether this product will be made active or not.

selectable decimal? - Whether this product can be selected in Deals or not.

visible_to record {}? - Visibility of the product. If omitted, visibility will be set to the default visibility setting of this item type for the authorized user.<table><tr><th>Value</th><th>Description</th></tr><tr><td>1</td><td>Owner & followers (private)</td><tr><td>3</td><td>Entire company (shared)</td></tr></table>

owner_id int? - ID of the user who will be marked as the owner of this product. When omitted, the authorized user ID will be used.

prices record {}[]? - Array of objects, each containing: currency (string), price (number), cost (number, optional), overhead_cost (number, optional). Note that there can only be one price per product per currency. When prices is omitted altogether, no prices will be set up for the product

pipedrive: AddRecurringSubscriptionRequest

Fields

deal_id int - ID of the Deal this Recurring Subscription is associated with

currency string - The currency of the Recurring Subscription. Accepts a 3-character currency code.

description string? - Description of the Recurring Subscription

cadence_type string - Interval between payments

cycles_count int? - Shows how many payments the Subscription has. Note that one field must be set: cycles_count or infinite. If cycles_count is set, then cycle_amount and start_date are also required.

cycle_amount int - Amount of each payment

start_date string - Start date of the Recurring Subscription. Format: YYYY-MM-DD

infinite boolean? - This indicates that the Recurring Subscription will last until it's manually canceled or deleted. Note that only one field must be set: cycles_count or infinite.

payments record {}[]? - Array of additional payments. It requires a minimum structure as follows: [{ amount:SUM, description:DESCRIPTION, due_at:PAYMENT_DATE }]. Replace SUM with a payment amount, DESCRIPTION with an explanation string, PAYMENT_DATE with a date (format YYYY-MM-DD).

update_deal_value boolean? - Indicates that the Deal value must be set to Recurring Subscription's MRR value

pipedrive: AddRoleAssignmentRequest

Fields

user_id int - ID of the user

pipedrive: AddRoleAssignmentResponse200

Fields

success boolean? - If the response is successful or not

data Addroleassignmentresponse200Data? - The response data

pipedrive: Addroleassignmentresponse200Data

The response data

Fields

user_id int? - The ID of the User that was added to the Role

role_id int? - The ID of the Role the User was added to

pipedrive: AddRoleRequest

Fields

parent_role_id int? - The ID of the parent Role

name string? - The name of the Role

pipedrive: AddRoleResponse200

Fields

success boolean? - If the response is successful or not

data Addroleresponse200Data? - The response data

pipedrive: Addroleresponse200Data

The response data

Fields

id record {}? - The ID of the created Role

pipedrive: AddStageRequest

Fields

name string - Name of the Stage

pipeline_id int - The ID of the Pipeline to add Stage to.

deal_probability int? - Deal success probability percentage. Used/shown when Deal weighted values are used

rotten_flag int? - Whether Deals in this stage can become rotten

rotten_days int? - The number of days the Deals not updated in this Stage would become rotten. Applies only if the rotten_flag is set.

pipedrive: AddSubscriptionInstallmentRequest

Fields

deal_id int - ID of the Deal this Installment Subscription is associated with

currency string - The currency of the Installment Subscription. Accepts a 3-character currency code.

payments record {}[] - Array of payments. It requires a minimum structure as follows: [{ amount:SUM, description:DESCRIPTION, due_at:PAYMENT_DATE }]. Replace SUM with a payment amount, DESCRIPTION with an explanation string, PAYMENT_DATE with a date (format YYYY-MM-DD).

update_deal_value boolean? - Indicates that the Deal value must be set to the Installment Subscription's total value

pipedrive: AddTeamRequest

Fields

name string - The Team name

description string? - The Team description

manager_id int - The Team manager ID

users int[]? - List of User IDs

pipedrive: AddTeamUserRequest

Fields

users int[] - List of User IDs

pipedrive: AddUserRequest

Fields

name string - Name of the user

email string - Email of the user

active_flag boolean - Whether the user is active or not. false = Not activated, true = Activated

pipedrive: AddUserRoleAssignmentRequest

Fields

role_id int - ID of the role

pipedrive: AddWebhookRequest

Fields

subscription_url string - A full, valid, publicly accessible URL. Determines where to send the notifications. Please note that you cannot use Pipedrive API endpoints as the subscription_url.

event_action string - Type of action to receive notifications about. Wildcard will match all supported actions.

event_object string - Type of object to receive notifications about. Wildcard will match all supported objects.

user_id int? - The ID of the user this webhook will be authorized with. If not set, current authorized user will be used. Note that this does not filter only certain user's events — rather, this specifies the user's permissions under which each event is checked. Events about objects the selected user is not entitled to access are not sent. If you want to receive notifications for all events, a top-level admin user should be used.

http_auth_user string? - HTTP basic auth username of the subscription URL endpoint (if required).

http_auth_password string? - HTTP basic auth password of the subscription URL endpoint (if required).

pipedrive: ApiKeysConfig

Closed record

Provides API key configurations needed when communicating with a remote HTTP endpoint.

Fields

apiToken string - Represents API Key api_token

pipedrive: BaseDeal

Fields

stage_id int? - The ID of the Deal stage

title string? - The title of the Deal

value decimal? - The value of the Deal

currency string? - The currency associated with the Deal

add_time string? - The creation date and time of the Deal

update_time string? - The last updated date and time of the Deal

stage_change_time string? - The last updated date and time of the Deal stage

active boolean? - If the Deal is activated or not

deleted boolean? - If the Deal is deleted or not

status string? - The status of the Deal

probability decimal? - The success probability percentage of the Deal

next_activity_date string? - The date of the next activity associated with the Deal

next_activity_time string? - The time of the next activity associated with the Deal

next_activity_id int? - The ID of the next activity associated with the Deal

last_activity_id int? - The ID of the last activity associated with the Deal

last_activity_date string? - The date of the last activity associated with the Deal

lost_reason string? - The reason for losing the Deal

visible_to string? - The visibility of the Deal

close_time string? - The date and time of closing the Deal

pipeline_id int? - The ID of pipeline associated with the Deal

won_time string? - The date and time of changing the Deal status as won

first_won_time string? - The date and time of the first time changing the Deal status as won

lost_time string? - The date and time of changing the Deal status as lost

products_count int? - The number of Products associated with the Deal

files_count int? - The number of Files associated with the Deal

notes_count int? - The number of Notes associated with the Deal

followers_count int? - The number of Followers associated with the Deal

email_messages_count int? - The number of emails associated with the Deal

activities_count int? - The number of Activities associated with the Deal

done_activities_count int? - The number of completed Activities associated with the Deal

undone_activities_count int? - The number of incomplete Activities associated with the Deal

participants_count int? - The number of Participants associated with the Deal

expected_close_date string? - The expected close date of the Deal

last_incoming_mail_time string? - The date and time of the last incoming email associated with the Deal

last_outgoing_mail_time string? - The date and time of the last outgoing email associated with the Deal

label string? - The label assigned to the Deal

stage_order_nr int? - The order number of the Deal stage associated with the Deal

person_name string? - The name of the Person associated with the Deal

org_name string? - The name of the Organization associated with the Deal

next_activity_subject string? - The subject of the next activity associated with the Deal

next_activity_type string? - The type of the next activity associated with the Deal

next_activity_duration string? - The duration of the next activity associated with the Deal

next_activity_note string? - The note of the next activity associated with the Deal

formatted_value string? - The Deal value formatted with selected currency. E.g. US$500

weighted_value decimal? - Probability times Deal value. Probability can either be Deal probability or if not set, then stage probability.

formatted_weighted_value string? - The weighted_value formatted with selected currency. E.g. US$500

weighted_value_currency string? - The currency associated with the Deal

rotten_time string? - The date and time of changing the Deal status as rotten

owner_name string? - The name of the Deal owner

cc_email string? - The Cc email of the Deal

org_hidden boolean? - If the Organization that is associated with the Deal is hidden or not

person_hidden boolean? - If the Person that is associated with the Deal is hidden or not

pipedrive: BaseMailThread

The mail thread object

Fields

Fields Included from *BaseMailThread1

id int|()
account_id string|()
user_id int|()
subject string|()
snippet string|()
read_flag record { anydata... }
mail_tracking_status string|()
has_attachments_flag record { anydata... }
has_inline_attachments_flag record { anydata... }
has_real_attachments_flag record { anydata... }
deleted_flag record { anydata... }
synced_flag record { anydata... }
smart_bcc_flag record { anydata... }
mail_link_tracking_enabled_flag record { anydata... }
write_flag boolean|()
anydata...

Fields Included from *BaseMailThread2

parties Basemailthread2Parties|()
drafts_parties record { anydata... }[]|()
folders string[]|()
version decimal|()
snippet_draft string|()
snippet_sent string|()
message_count int|()
has_draft_flag record { anydata... }
has_sent_flag record { anydata... }
archived_flag record { anydata... }
shared_flag record { anydata... }
external_deleted_flag record { anydata... }
first_message_to_me_flag record { anydata... }
last_message_timestamp string|()
first_message_timestamp string|()
last_message_sent_timestamp string|()
last_message_received_timestamp string|()
add_time string|()
update_time string|()
deal_id int|()
deal_status string|()
lead_id string|()
all_messages_sent_flag record { anydata... }
anydata...

pipedrive: BaseMailThread1

Fields

id int? - ID of the mail thread

account_id string? - The connection account ID

user_id int? - ID of the user whom mail message will be assigned to

subject string? - The subject

snippet string? - A snippet

read_flag record {}? - Whether the mail thread is read

mail_tracking_status string? - Mail tracking status

has_attachments_flag record {}? - Whether the mail thread has an attachment

has_inline_attachments_flag record {}? - Whether the mail thread has inline attachments

has_real_attachments_flag record {}? - Whether the mail thread has real attachments (which are not inline)

deleted_flag record {}? - Whether the mail thread is deleted

synced_flag record {}? - Whether the mail thread is synced

smart_bcc_flag record {}? - Whether one of the parties of the mail thread is Bcc

mail_link_tracking_enabled_flag record {}? - Whether the link tracking of the mail thread is enabled

write_flag boolean? - We strongly advise you to avoid the use of this property. We will soon deprecate this property

pipedrive: BaseMailThread2

Fields

parties Basemailthread2Parties? - Parties of the mail thread

drafts_parties record {}[]? - Parties of the drafted mail thread

folders string[]? - Folders in which messages from thread are being stored

'version decimal? - Version

snippet_draft string? - A snippet from a draft

snippet_sent string? - A snippet from a message sent

message_count int? - An amount of messages

has_draft_flag record {}? - Whether the mail thread has any drafts

has_sent_flag record {}? - Whether the mail thread has messages sent

archived_flag record {}? - Whether the mail thread is archived

shared_flag record {}? - Whether the mail thread is shared

external_deleted_flag record {}? - Whether the mail thread has been deleted externally

first_message_to_me_flag record {}? - Whether the mail thread was initialized by others

last_message_timestamp string? - Last message timestamp

first_message_timestamp string? - The time when the mail thread has had the first message received or created

last_message_sent_timestamp string? - The last time when the mail thread has had a message sent

last_message_received_timestamp string? - The last time when the mail thread has had a message received

add_time string? - The time when the mail thread was inserted to database

update_time string? - The time when the mail thread was updated in database received

deal_id int? - The ID of the deal

deal_status string? - Status of the deal

lead_id string? - The ID of the lead

all_messages_sent_flag record {}? - Whether all the mail thread messages have been sent

pipedrive: Basemailthread2Parties

Parties of the mail thread

Fields

to Basemailthread2PartiesTo[]? - Recipients of the mail thread

'from Basemailthread2PartiesTo[]? - Senders of the mail thread

pipedrive: Basemailthread2PartiesTo

Member of a thread

Fields

id int? - ID of the mail thread participant

name string? - Name of the mail thread participant

latest_sent boolean? - Whether the mail thread participant was last to send an email

email_address string? - Email address of the mail thread participant

message_time decimal? - Message time

linked_person_id int? - ID of the linked person

linked_person_name string? - Email of the linked person

mail_message_party_id int? - ID of the mail message party

linked_organization_id int? - Linked Organization ID

pipedrive: BaseMailThreadData

The mail thread object

Fields

Fields Included from *BaseMailThread1

id int|()
account_id string|()
user_id int|()
subject string|()
snippet string|()
read_flag record { anydata... }
mail_tracking_status string|()
has_attachments_flag record { anydata... }
has_inline_attachments_flag record { anydata... }
has_real_attachments_flag record { anydata... }
deleted_flag record { anydata... }
synced_flag record { anydata... }
smart_bcc_flag record { anydata... }
mail_link_tracking_enabled_flag record { anydata... }
write_flag boolean|()
anydata...

Fields Included from *BaseMailThread2

parties Basemailthread2Parties|()
drafts_parties record { anydata... }[]|()
folders string[]|()
version decimal|()
snippet_draft string|()
snippet_sent string|()
message_count int|()
has_draft_flag record { anydata... }
has_sent_flag record { anydata... }
archived_flag record { anydata... }
shared_flag record { anydata... }
external_deleted_flag record { anydata... }
first_message_to_me_flag record { anydata... }
last_message_timestamp string|()
first_message_timestamp string|()
last_message_sent_timestamp string|()
last_message_received_timestamp string|()
add_time string|()
update_time string|()
deal_id int|()
deal_status string|()
lead_id string|()
all_messages_sent_flag record { anydata... }
anydata...

pipedrive: BaseOrganizationItem

Fields

Fields Included from *BaseOrganizationItem1

id int|()
company_id int|()
owner_id record { id int|(), name string|(), email string|(), has_pic int|(), pic_hash string|(), active_flag boolean|(), value int|(), anydata... }
name string|()
active_flag boolean|()
picture_id record { id int|(), item_type string|(), item_id int|(), active_flag boolean|(), add_time string|(), update_time string|(), added_by_user_id int|(), pictures Pictures|(), anydata... }
country_code string|()
first_char string|()
add_time string|()
update_time string|()
visible_to string|()
label int|()
owner_name string|()
cc_email string|()
anydata...

Fields Included from *AdditionalBaseOrganizationItemInfo

email_messages_count int|()
people_count int|()
activities_count int|()
done_activities_count int|()
undone_activities_count int|()
files_count int|()
notes_count int|()
followers_count int|()
address string|()
address_subpremise string|()
address_street_number string|()
address_route string|()
address_sublocality string|()
address_locality string|()
address_admin_area_level_1 string|()
address_admin_area_level_2 string|()
address_country string|()
address_postal_code string|()
address_formatted_address string|()
open_deals_count int|()
related_open_deals_count int|()
closed_deals_count int|()
related_closed_deals_count int|()
won_deals_count int|()
related_won_deals_count int|()
lost_deals_count int|()
related_lost_deals_count int|()
next_activity_date string|()
next_activity_time string|()
next_activity_id int|()
last_activity_id int|()
last_activity_date string|()
anydata...

pipedrive: BaseOrganizationItem1

Fields

id int? - The ID of the Organization

company_id int? - The ID of the Company related to the Organization

owner_id record {}? -

name string? - The name of the Organization

active_flag boolean? - If the Organization is activated or not

picture_id record {}? -

country_code string? - The country code of the Organization

first_char string? - The first character of the Organization name

add_time string? - The creation date and time of the Organization

update_time string? - The last updated date and time of the Organization

visible_to string? - The visibility group ID of who can see the Organization

label int? - The ID of the label

owner_name string? - The name of the Organization owner

cc_email string? - The CC email of the Organization

pipedrive: BaseOrganizationItemWithEditNameFlag

Fields

Fields Included from *BaseOrganizationItem

id int|()
company_id int|()
owner_id record { id int|(), name string|(), email string|(), has_pic int|(), pic_hash string|(), active_flag boolean|(), value int|(), anydata... }
name string|()
active_flag boolean|()
picture_id record { id int|(), item_type string|(), item_id int|(), active_flag boolean|(), add_time string|(), update_time string|(), added_by_user_id int|(), pictures Pictures|(), anydata... }
country_code string|()
first_char string|()
add_time string|()
update_time string|()
visible_to string|()
label int|()
owner_name string|()
cc_email string|()
email_messages_count int|()
people_count int|()
activities_count int|()
done_activities_count int|()
undone_activities_count int|()
files_count int|()
notes_count int|()
followers_count int|()
address string|()
address_subpremise string|()
address_street_number string|()
address_route string|()
address_sublocality string|()
address_locality string|()
address_admin_area_level_1 string|()
address_admin_area_level_2 string|()
address_country string|()
address_postal_code string|()
address_formatted_address string|()
open_deals_count int|()
related_open_deals_count int|()
closed_deals_count int|()
related_closed_deals_count int|()
won_deals_count int|()
related_won_deals_count int|()
lost_deals_count int|()
related_lost_deals_count int|()
next_activity_date string|()
next_activity_time string|()
next_activity_id int|()
last_activity_id int|()
last_activity_date string|()
anydata...

Fields Included from *BaseOrganizationItemWithEditNameFlag1

edit_name boolean|()
anydata...

pipedrive: BaseOrganizationItemWithEditNameFlag1

Fields

edit_name boolean? - If the company ID of the Organization and company ID of the request is same or not

pipedrive: BaseOrganizationItemWithEditNameFlagData

Fields

Fields Included from *BaseOrganizationItem

id int|()
company_id int|()
owner_id record { id int|(), name string|(), email string|(), has_pic int|(), pic_hash string|(), active_flag boolean|(), value int|(), anydata... }
name string|()
active_flag boolean|()
picture_id record { id int|(), item_type string|(), item_id int|(), active_flag boolean|(), add_time string|(), update_time string|(), added_by_user_id int|(), pictures Pictures|(), anydata... }
country_code string|()
first_char string|()
add_time string|()
update_time string|()
visible_to string|()
label int|()
owner_name string|()
cc_email string|()
email_messages_count int|()
people_count int|()
activities_count int|()
done_activities_count int|()
undone_activities_count int|()
files_count int|()
notes_count int|()
followers_count int|()
address string|()
address_subpremise string|()
address_street_number string|()
address_route string|()
address_sublocality string|()
address_locality string|()
address_admin_area_level_1 string|()
address_admin_area_level_2 string|()
address_country string|()
address_postal_code string|()
address_formatted_address string|()
open_deals_count int|()
related_open_deals_count int|()
closed_deals_count int|()
related_closed_deals_count int|()
won_deals_count int|()
related_won_deals_count int|()
lost_deals_count int|()
related_lost_deals_count int|()
next_activity_date string|()
next_activity_time string|()
next_activity_id int|()
last_activity_id int|()
last_activity_date string|()
anydata...

edit_name boolean? - If the company ID of the Organization and company ID of the request is same or not

pipedrive: BasePipelineWithSelectedFlag

Fields

Fields Included from *Pipeline1

id int|()
name string|()
url_title string|()
order_nr int|()
active boolean|()
deal_probability boolean|()
add_time string|()
update_time string|()
anydata...

Fields Included from *Pipeline2

selected boolean|()
anydata...

pipedrive: BaseResponse200

Fields

success boolean? - If the response is successful or not

status string? - The status of the response

pipedrive: BaseRoleRequest

Details of the role

Fields

parent_role_id int? - The ID of the parent Role

name string? - The name of the Role

pipedrive: BaseTeam

Fields

id int? - The Team ID

Fields Included from *UpdateTeamWithAdditionalProperties

add_time string|()
created_by_user_id int|()
name string|()
description string|()
manager_id int|()
users int[]|()
active_flag record { anydata... }
deleted_flag record { anydata... }
anydata...

pipedrive: BasicDeal

Fields

title string? - Deal title

value string? - Value of the deal. If omitted, value will be set to 0.

currency string? - Currency of the deal. Accepts a 3-character currency code. If omitted, currency will be set to the default currency of the authorized user.

user_id int? - ID of the user who will be marked as the owner of this deal. If omitted, the authorized user ID will be used.

person_id int? - ID of the person this deal will be associated with

org_id int? - ID of the organization this deal will be associated with

stage_id int? - ID of the stage this deal will be placed in a pipeline (note that you can't supply the ID of the pipeline as this will be assigned automatically based on stage_id). If omitted, the deal will be placed in the first stage of the default pipeline.

status string? - open = Open, won = Won, lost = Lost, deleted = Deleted. If omitted, status will be set to open.

expected_close_date string? - The expected close date of the Deal. In ISO 8601 format: YYYY-MM-DD.

probability decimal? - Deal success probability percentage. Used/shown only when deal_probability for the pipeline of the deal is enabled.

lost_reason string? - Optional message about why the deal was lost (to be used when status=lost)

visible_to record {}? - Visibility of the deal. If omitted, visibility will be set to the default visibility setting of this item type for the authorized user.<table><tr><th>Value</th><th>Description</th></tr><tr><td>1</td><td>Owner & followers (private)</td></tr><tr><td>3</td><td>Entire company (shared)</td></tr></table>

pipedrive: BasicDealProductRequest

Fields

item_price decimal? - Price at which this product will be added to the deal

quantity int? - Quantity – e.g. how many items of this product will be added to the deal

discount_percentage decimal? - Discount %. If omitted, will be set to 0

duration decimal? - Duration of the product (when product durations are not enabled for the company or if omitted, defaults to 1)

product_variation_id int? - ID of the product variation to use. When omitted, no variation will be used.

comments string? - Any textual comment associated with this product-deal attachment. Visible and editable in the application UI.

enabled_flag record {}? - Whether the product is enabled on the deal or not. This makes it possible to add products to a deal with specific price and discount criteria - but keep them disabled, which refrains them from being included in deal price calculation. When omitted, the product will be marked as enabled by default.

pipedrive: BasicDealProductRequestData

Fields

Fields Included from *BasicDealProductRequestData1

item_price decimal|()
quantity int|()
discount_percentage decimal|()
duration decimal|()
product_variation_id int|()
comments string|()
enabled_flag record { anydata... }
anydata...

Fields Included from *BasicDealProductRequestData2

id int|()
company_id int|()
deal_id int|()
product_id int|()
duration_unit string|()
sum_no_discount decimal|()
sum decimal|()
currency string|()
add_time string|()
last_edit string|()
active_flag boolean|()
tax decimal|()
name string|()
anydata...

pipedrive: BasicDealProductRequestData1

Fields

item_price decimal? - Price at which this product will be added to the deal

quantity int? - Quantity – e.g. how many items of this product will be added to the deal

discount_percentage decimal? - Discount %. If omitted, will be set to 0

duration decimal? - Duration of the product (when product durations are not enabled for the company or if omitted, defaults to 1)

product_variation_id int? - ID of the product variation to use. When omitted, no variation will be used.

comments string? - Any textual comment associated with this product-deal attachment. Visible and editable in the application UI.

enabled_flag record {}? - Whether the product is enabled on the deal or not. This makes it possible to add products to a deal with specific price and discount criteria - but keep them disabled, which refrains them from being included in deal price calculation. When omitted, the product will be marked as enabled by default.

pipedrive: BasicDealProductRequestData2

Fields

id int? - The ID of the deal-product (the ID of the Product attached to the Deal)

company_id int? - The ID of the Company

deal_id int? - The ID of the Deal

product_id int? - The ID of the Product

duration_unit string? - The type of the duration. (For example hourly, daily, etc.)

sum_no_discount decimal? - The Product sum without the discount

sum decimal? - The sum of all the Products attached to the Deal

currency string? - The currency associated with the Deal Product

add_time string? - The date and time when the Product was added to the Deal

last_edit string? - The date and time when the Deal Product was last edited

active_flag boolean? - Boolean indicates if the Product is activated or not

tax decimal? - The Product tax

name string? - The Product name

pipedrive: BasicGoalRequest

Fields

title string? - Title of the goal.

assignee record {}? - Who is this goal assigned to. It requires the following JSON structure: { "id": "1", "type": "person" }. type can be either person, company or team. ID of the assignee person, company or team.

'type record {}? - Type of the goal. It requires the following JSON structure: { "name": "deals_started", "params": { "pipeline_id": 1 } }. Type can be one of: deals_won, deals_progressed, activities_completed, activities_added, deals_started or revenue_forecast. params can include pipeline_id, stage_id or activity_type_id. stage_id is related to only deals_progressed type of goals and activity_type_id to activities_completed or activities_added types of goals. To track goal in all pipelines set pipeline_id as null.

expected_outcome record {}? - Expected outcome of the goal. Expected outcome can be tracked either by quantity or by sum. It requires the following JSON structure: { "target": "50", "tracking_metric": "quantity" } or { "target": "50", "tracking_metric": "sum", "currency_id": 1 }. currency_id should only be added to sum type of goals.

duration record {}? - Date when the goal starts and ends. It requires the following JSON structure: { "start": "2019-01-01", "end": "2022-12-31" }. Date in format of YYYY-MM-DD. "end" can be set to null for an infinite, open-ended goal.

interval string? - Interval of the goal

pipedrive: BasicOrganization

Fields

name string? - Organization name

owner_id int? - The ID of the user who will be marked as the owner of this Organization. When omitted, the authorized User ID will be used.

visible_to record {}? - Visibility of the organization. If omitted, visibility will be set to the default visibility setting of this item type for the authorized user.<table><tr><th>Value</th><th>Description</th></tr><tr><td>1</td><td>Owner & followers (private)</td></tr><tr><td>3</td><td>Entire company (shared)</td></tr></table>

pipedrive: BasicPersonRequest

Fields

name string? - Person name

owner_id int? - ID of the user who will be marked as the owner of this person. When omitted, the authorized user ID will be used.

org_id int? - ID of the organization this person will belong to.

email string[]? - Email addresses (one or more) associated with the person, presented in the same manner as received by GET request of a person.

phone string[]? - Phone numbers (one or more) associated with the person, presented in the same manner as received by GET request of a person.

visible_to record {}? - Visibility of the person. If omitted, visibility will be set to the default visibility setting of this item type for the authorized user.<table><tr><th>Value</th><th>Description</th></tr><tr><td>1</td><td>Owner & followers (private)</td></tr><tr><td>3</td><td>Entire company (shared)</td></tr></table>

pipedrive: CallLogResponse400

Fields

success boolean? -

'error string? - The description of the error

error_info string? - A message describing how to solve the problem

data record {}? -

additional_data record {}? -

pipedrive: CallLogResponse403

Fields

success boolean? -

'error string? - The description of the error

error_info string? - A message describing how to solve the problem

data record {}? -

additional_data record {}? -

pipedrive: CallLogResponse404

Fields

success boolean? -

'error string? - The description of the error

error_info string? - A message describing how to solve the problem

data record {}? -

additional_data record {}? -

pipedrive: CallLogResponse410

Fields

success boolean? -

'error string? - The description of the error

error_info string? - A message describing how to solve the problem

data record {}? -

additional_data record {}? -

pipedrive: CallLogResponse500

Fields

success boolean? -

'error string? - The description of the error

error_info string? - A message describing how to solve the problem

data record {}? -

additional_data record {}? -

pipedrive: CancelRecurringSubscriptionRequest

Fields

end_date string? - Subscription termination date. All payments after specified date will be deleted. Default value is the current date.

pipedrive: ClientHttp1Settings

Closed record

Provides settings related to HTTP/1.x protocol.

Fields

keepAlive KeepAlive(default http:KEEPALIVE_AUTO) - Specifies whether to reuse a connection for multiple requests

chunking Chunking(default http:CHUNKING_AUTO) - The chunking behaviour of the request

proxy ProxyConfig? - Proxy server related options

pipedrive: CommentPostPutObject

Fields

content string - Content of the comment in HTML format. Subject to sanitization on the back-end.

pipedrive: Commentpostputobject1

Fields

content string - Content of the comment in HTML format. Subject to sanitization on the back-end.

clients

records

ballerinax/pipedrive Ballerina library

Overview

Prerequisites

Quickstart

Step 1: Import connector

Step 2: Create a new connector instance

Step 3: Invoke connector operation

Clients

pipedrive: Client

Constructor

getActivities

Parameters

Return Type

addActivity

Parameters

Return Type

deleteActivities

Parameters

Return Type

getActivity

Parameters

Return Type

updateActivity

Parameters

Return Type

deleteActivity

Parameters

Return Type

getActivityFields

Return Type

getActivityTypes

Return Type

addActivityType

Parameters

Return Type

deleteActivityTypes

Parameters

Return Type

updateActivityType

Parameters

Return Type

deleteActivityType

Parameters

Return Type

getUserCallLogs

Parameters

Return Type

addCallLog

Parameters

Return Type

getCallLog

Parameters

Return Type

deleteCallLog

Parameters

Return Type

getCurrencies

Parameters

Return Type

getDeals

Parameters

Return Type

addDeal

Parameters

Return Type

deleteDeals

Parameters

Return Type

searchDeals

Parameters

Return Type

getDealsByName

Parameters

Return Type

Deprecated

getDealsSummary

Parameters

Return Type