Overview
The Pipedrive connector for Bizagi is available for download at Bizagi Connectors Xchange.
Through this connector, youcan connect your Bizagi processes to your Pipedrive account and services.
For more information about this connector's capabilities, visit Bizagi Connectors Xchange.
|
This Connector was developed according to the contents of the API and the information about it provided by Pipedrive. Bizagi and its subsidiaries will not provide any kind of guarantee over the content or error caused by calling the API services. Bizagi and its subsidiaries are not responsible for any loss, cost or damage consequence of the calls to Pipedrive 's API. |
Before you start
To test and use this connector, you need:
1.Bizagi Studio installed.
2.This connector installed, via the Connectors Xchange as described at https://help.bizagi.com/platform/en/index.html?Connectors_Xchange.htm, or through a manual installation as described at https://help.bizagi.com/platform/en/index.html?connectors_setup.htm.
3.A Sandbox account and an API key for your Pipedrive.
Obtain your Pipedrive Sandbox and API key
Follow this steps to create your Sandbox account.
1.Go to https://pipedrive.readme.io/docs/developer-sandbox-account.
2.On the second paragraph click the webform link.
3.Fill all the required fields of the form
4.Pipedrive will approve and create your domain in the following 24-48 hours
Configuring the connector
To configure the connector (in particular its authentication parameters), follow the steps presented at the Configuration chapter in https://help.bizagi.com/platform/en/index.html?connectors_setup.htm.
For this configuration, consider the following authentication parameters:
•Authentication method: Custom
•DOMAIN: Domain (URL) assigned for your Pipedrive.
•API_KEY: API key provided with your domain.
Using the connector
This connector features a set of methods to help you take advantage of the capabilites ofPipedrive's API services.
To learn overall how/where to configure the use of a connector, refer to https://help.bizagi.com/platform/en/index.html?Connectors_Studio.htm.
When using the connector, keep in mind the following details for the available method.
Add an organization
This action adds a new organization/company to the system.
To configure its inputs, take into account the following descriptions:
•name (Required): name of the organization. This parameter should be a String in your Bizagi model.
•owner_id: ID of the owner, if no information is provided the action uses the authenticated user. This parameter should be a String in your Bizagi model.
•address: address of the organization. This parameter should be a String in your Bizagi model.
To configure the outputs of this action, you can map the output object to the corresponding entity in Bizagi. Make sure you map the attributes of the entity appropriately.
For more information about using this method, refer to Pipedrive 's official documentation at https://developers.pipedrive.com/docs/api/v1/#!/Organizations.
Update an organization
This action updates an organization/company in the system.
To configure its inputs, take into account the following descriptions:
•id (Required): ID of the organization. This parameter should be a String in your Bizagi model.
•name (Required): name of the organization. This parameter should be a String in your Bizagi model.
•owner_id: ID of the owner, if no information is provided the action uses the authenticated user. This parameter should be a String in your Bizagi model.
•address: address of the organization. This parameter should be a String in your Bizagi model.
To configure the outputs of this action, you can map the output object to the corresponding entity in Bizagi. Make sure you map the attributes of the entity appropriately.
For more information about using this method, refer to Pipedrive 's official documentation at https://developers.pipedrive.com/docs/api/v1/#!/Organizations.
Delete an organization
This action deletes an organization/company of the system.
To configure its inputs, take into account the following descriptions:
•id (Required): ID of the organization. This parameter should be a String in your Bizagi model.
To configure the outputs of this action, you can map the output object to the corresponding entity in Bizagi. Make sure you map the attributes of the entity appropriately.
For more information about using this method, refer to Pipedrive 's official documentation at https://developers.pipedrive.com/docs/api/v1/#!/Organizations.
Get details of an organization
This action gets detailed information of an organization/company.
To configure its inputs, take into account the following descriptions:
•id (Required): ID of the organization. This parameter should be a String in your Bizagi model.
To configure the outputs of this action, you can map the output object to the corresponding entity in Bizagi. Make sure you map the attributes of the entity appropriately.
For more information about using this method, refer to Pipedrive 's official documentation at https://developers.pipedrive.com/docs/api/v1/#!/Organizations.
Find organizations by name
This action finds organizations/companies using a keyword.
To configure its inputs, take into account the following descriptions:
•term (Required): key word of the search. This parameter should be a String in your Bizagi model.
•start: index where the results start. This parameter should be a number in your Bizagi model.
•limit: number of record to fetch. This parameter should be a number in your Bizagi model.
To configure the outputs of this action, you can map the output object to the corresponding entity in Bizagi. Make sure you map the attributes of the entity appropriately.
For more information about using this method, refer to Pipedrive 's official documentation at https://developers.pipedrive.com/docs/api/v1/#!/Organizations.
List persons of an organization
This action gets a list of persons in an organization.
To configure its inputs, take into account the following descriptions:
•org_id (Required): ID of the organization. This parameter should be a number in your Bizagi model.
•start: index where the results start. This parameter should be a number in your Bizagi model.
•limit: number of record to fetch. This parameter should be a number in your Bizagi model.
To configure the outputs of this action, you can map the output object to the corresponding entity in Bizagi. Make sure you map the attributes of the entity appropriately.
For more information about using this method, refer to Pipedrive 's official documentation at https://developers.pipedrive.com/docs/api/v1/#!/Organizations.
List deals associated with an organization
This action gets a list of deals of an organization/company.
To configure its inputs, take into account the following descriptions:
•org_id (Required): ID of the organization . This parameter should be a number in your Bizagi model.
•start: index where the results start. This parameter should be a number in your Bizagi model.
•limit: number of record to fetch. This parameter should be a number in your Bizagi model.
To configure the outputs of this action, you can map the output object to the corresponding entity in Bizagi. Make sure you map the attributes of the entity appropriately.
For more information about using this method, refer to Pipedrive 's official documentation at https://developers.pipedrive.com/docs/api/v1/#!/Organizations.
List activities associated with an organization
This action gets the list of activites of an organization/company.
To configure its inputs, take into account the following descriptions:
•org_id (Required): ID of the organization . This parameter should be a number in your Bizagi model.
•start: index where the results start. This parameter should be a number in your Bizagi model.
•limit: number of record to fetch. This parameter should be a number in your Bizagi model.
To configure the outputs of this action, you can map the output object to the corresponding entity in Bizagi. Make sure you map the attributes of the entity appropriately.
For more information about using this method, refer to Pipedrive 's official documentation at https://developers.pipedrive.com/docs/api/v1/#!/Organizations.
Add an activity
This action adds a new activity to the system.
To configure its inputs, take into account the following descriptions:
•subject (Required): title of the activity. This parameter should be a String in your Bizagi model.
•done: wheter the task is completed (0 = not done, 1 = done). This parameter should be a number in your Bizagi model.
•type (Required): type of the activity (call = 1, meeting = 2, task = 3, deadline = 4, email = 5, lunch = 6). This parameter should be a number in your Bizagi model.
•due_date: due date of the activity (YYYY-MM-DD). This parameter should be a date in your Bizagi model.
•due_time: time limit of the activity (HH:MM). This parameter should be a String in your Bizagi model.
•duration: duration of the activity (HH:MM). This parameter should be a String in your Bizagi model.
•user_id: ID of the user assigned to the activity, if no information is provided the action uses the authenticated user. This parameter should be a double in your Bizagi model.
•deal_id: ID of the deal associated with the activity. This parameter should be a number in your Bizagi model.
•person_id: ID of the person associated with the activity. This parameter should be a number in your Bizagi model.
•org_id: ID of the organization performing the activity. This parameter should be a number in your Bizagi model.
•note: aditional notes. This parameter should be a String in your Bizagi model.
To configure the outputs of this action, you can map the output object to the corresponding entity in Bizagi. Make sure you map the attributes of the entity appropriately.
For more information about using this method, refer to Pipedrive 's official documentation at https://developers.pipedrive.com/docs/api/v1/#!/Activities.
Edit an activity
This action updates an activity in the system.
To configure its inputs, take into account the following descriptions:
•id (Required): ID of the activity. This parameter should be a number in your Bizagi model.
•subject (Required): title of the activity. This parameter should be a String in your Bizagi model.
•done: wheter the task is completed (0 = not done, 1 = done). This parameter should be a number in your Bizagi model.
•type (Required): type of the activity (call = 1, meeting = 2, task = 3, deadline = 4, email = 5, lunch = 6). This parameter should be a number in your Bizagi model.
•due_date: due date of the activity (YYYY-MM-DD). This parameter should be a date in your Bizagi model.
•due_time: time limit of the activity (HH:MM). This parameter should be a String in your Bizagi model.
•duration: duration of the activity (HH:MM). This parameter should be a String in your Bizagi model.
•user_id: ID of the user assigned to the activity, if no information is provided the action uses the authenticated user. This parameter should be a double in your Bizagi model.
•deal_id: ID of the deal associated with the activity. This parameter should be a number in your Bizagi model.
•person_id: ID of the person associated with the activity. This parameter should be a number in your Bizagi model.
•org_id: ID of the organization performing the activity. This parameter should be a number in your Bizagi model.
•note: aditional notes. This parameter should be a String in your Bizagi model.
To configure the outputs of this action, you can map the output object to the corresponding entity in Bizagi. Make sure you map the attributes of the entity appropriately.
For more information about using this method, refer to Pipedrive 's official documentation at https://developers.pipedrive.com/docs/api/v1/#!/Activities.
Delete an activity
This action deletes an activity.
To configure its inputs, take into account the following descriptions:
•id (Required): ID of the activity. This parameter should be a number in your Bizagi model.
To configure the outputs of this action, you can map the output object to the corresponding entity in Bizagi. Make sure you map the attributes of the entity appropriately.
For more information about using this method, refer to Pipedrive 's official documentation at https://developers.pipedrive.com/docs/api/v1/#!/Activities.
Get details of an activity
This action gets detailed information of an activity.
To configure its inputs, take into account the following descriptions:
•id (Required): ID of the activity. This parameter should be a number in your Bizagi model.
To configure the outputs of this action, you can map the output object to the corresponding entity in Bizagi. Make sure you map the attributes of the entity appropriately.
For more information about using this method, refer to Pipedrive 's official documentation at https://developers.pipedrive.com/docs/api/v1/#!/Activities.
Get all activities assigned to a particular user
This action gets a list of activities of a particular user.
To configure its inputs, take into account the following descriptions:
•user_id: ID of the user, if no information is provided the action uses the authenticated user. To search activities of all the users of the organizationset this value to 0. This parameter should be a double in your Bizagi model.
•type: type of the activity (call = 1, meeting = 2, task = 3, deadline = 4, email = 5, lunch = 6). This parameter should be a number in your Bizagi model.
•start: index where the results start. This parameter should be a number in your Bizagi model.
•limit: number of record to fetch. This parameter should be a number in your Bizagi model.
•start_date: start date of the search (YYYY-MM-DD). This parameter should be a date in your Bizagi model.
•end_date: end date of the search (YYYY-MM-DD). This parameter should be a date in your Bizagi model.
•done: Wheter the activity is finished. 0 = Not Done, 1 = Done. This parameter should be a number in your Bizagi model.
To configure the outputs of this action, you can map the output object to the corresponding entity in Bizagi. Make sure you map the attributes of the entity appropriately.
For more information about using this method, refer to Pipedrive 's official documentation at https://developers.pipedrive.com/docs/api/v1/#!/Activities.
Add a Deal
This action adds a new deal.
To configure its inputs, take into account the following descriptions:
•title (Required): title of the deal. This parameter should be a String in your Bizagi model.
•value: amount of the deal, if no information is provided the action uses 0 as default. This parameter should be a String in your Bizagi model.
•currency: currency in a 3 character code (USD, GBP, JPY). If no information is provided the action uses the default currency of the authenticated user. This parameter should be a String in your Bizagi model.
•user_id: ID of the user owner of the deal. This parameter should be a double in your Bizagi model.
•person_id: ID of the person asociated with the deal. This parameter should be a number in your Bizagi model.
•org_id: ID of the organization. This parameter should be a number in your Bizagi model.
•stage_id: ID of the stage in which the deal will be closed (Keep in mind that you can not provide the ID of the pipeline since this is assigned authomatically using this field). If no information is provided the action uses the first stage of the default pipeline. This parameter should be a number in your Bizagi model.
•status: Status of the deal. Possible values open = Open, won = Won, lost = Lost, deleted = Deleted. This parameter should be a String in your Bizagi model.
•probability: probability of success of the deal (percentage). This parameter should be a String in your Bizagi model.
•lost_reason: optional message explaining why the deal was lost (can only be used when the status is lost). This parameter should be a String in your Bizagi model.
•add_time: creation date (requieres an admin type API key). This parameter should be a date in your Bizagi model.
•visible_to: visibility of the deal(1, owners y followers - private) y (3, entire company - shared)
To configure the outputs of this action, you can map the output object to the corresponding entity in Bizagi. Make sure you map the attributes of the entity appropriately.
For more information about using this method, refer to Pipedrive 's official documentation at https://developers.pipedrive.com/docs/api/v1/#!/Deals.
Update a Deal
This action updates the information of a deal.
To configure its inputs, take into account the following descriptions:
•id (Required): ID of the deal. This parameter should be a String in your Bizagi model.
•title (Required): title of the deal. This parameter should be a String in your Bizagi model.
•value: amount of the deal, if no information is provided the action uses 0 as default. This parameter should be a String in your Bizagi model.
•currency: currency in a 3 character code (USD, GBP, JPY). If no information is provided the action uses the default currency of the authenticated user. This parameter should be a String in your Bizagi model.
•user_id: ID of the user owner of the deal. This parameter should be a double in your Bizagi model.
•person_id: ID of the person asociated with the deal. This parameter should be a number in your Bizagi model.
•org_id: ID of the organization. This parameter should be a number in your Bizagi model.
•stage_id: ID of the stage in which the deal will be closed (Keep in mind that you can not provide the ID of the pipeline since this is assigned authomatically using this field). If no information is provided the action uses the first stage of the default pipeline. This parameter should be a number in your Bizagi model.
•status: Status of the deal. Possible values open = Open, won = Won, lost = Lost, deleted = Deleted. This parameter should be a String in your Bizagi model.
•probability: probability of success of the deal (percentage). If the pipline is configured to use this probability this field is required. This parameter should be a String in your Bizagi model.
•lost_reason: optional message explaining why the deal was lost (can only be used when the status is lost). This parameter should be a String in your Bizagi model.
•add_time: creation date (requieres an admin type API key). This parameter should be a date in your Bizagi model.
•visible_to: visibility of the deal(1, owners y followers - private) y (3, entire company - shared)
To configure the outputs of this action, you can map the output object to the corresponding entity in Bizagi. Make sure you map the attributes of the entity appropriately.
For more information about using this method, refer to Pipedrive 's official documentation at https://developers.pipedrive.com/docs/api/v1/#!/Deals.
Delete a Deal
This action deletes a deal.
To configure its inputs, take into account the following descriptions:
•id (Required): ID of the deal. This parameter should be a String in your Bizagi model.
To configure the outputs of this action, you can map the output object to the corresponding entity in Bizagi. Make sure you map the attributes of the entity appropriately.
For more information about using this method, refer to Pipedrive 's official documentation at https://developers.pipedrive.com/docs/api/v1/#!/Deals.
Get all deals
This action gets a list of deals of an organization/company.
To configure its inputs, take into account the following descriptions:
•user_id: filters the deals assigned to this user. This parameter should be a String in your Bizagi model.
•stage_id: filters the deals in a stage. This parameter should be a number in your Bizagi model.
•status: filters the deals in a particular status. If no information is provided the action returns all the deals without the deleted status. This parameter should be a String in your Bizagi model.
•start: index where the results start. This parameter should be a number in your Bizagi model.
•limit: number of record to fetch. This parameter should be a number in your Bizagi model.
To configure the outputs of this action, you can map the output object to the corresponding entity in Bizagi. Make sure you map the attributes of the entity appropriately.
For more information about using this method, refer to Pipedrive 's official documentation at https://developers.pipedrive.com/docs/api/v1/#!/Deals.
Find deals by name
This action gets a list of deals that contain a name.
To configure its inputs, take into account the following descriptions:
•term (Required): key word of the search. This term must appear in the title of the deal. This parameter should be a String in your Bizagi model.
To configure the outputs of this action, you can map the output object to the corresponding entity in Bizagi. Make sure you map the attributes of the entity appropriately.
For more information about using this method, refer to Pipedrive 's official documentation at https://developers.pipedrive.com/docs/api/v1/#!/Deals.
Get details of a deal
This action gets detailed information of a deal.
To configure its inputs, take into account the following descriptions:
•id (Required): ID of the deal. This parameter should be a number in your Bizagi model.
To configure the outputs of this action, you can map the output object to the corresponding entity in Bizagi. Make sure you map the attributes of the entity appropriately.
For more information about using this method, refer to Pipedrive 's official documentation at https://developers.pipedrive.com/docs/api/v1/#!/Deals.
List participants associated with a deal
This action gets los participantes de un acuerdo.
To configure its inputs, take into account the following descriptions:
•id: ID of the deal. This parameter should be a String in your Bizagi model.
•start: index where the results start. This parameter should be a number in your Bizagi model.
•limit: number of record to fetch. This parameter should be a number in your Bizagi model.
To configure the outputs of this action, you can map the output object to the corresponding entity in Bizagi. Make sure you map the attributes of the entity appropriately.
For more information about using this method, refer to Pipedrive 's official documentation at https://developers.pipedrive.com/docs/api/v1/#!/Deals.
Add a person
This action adds a new person.
To configure its inputs, take into account the following descriptions:
•name (Required): name of the person. This parameter should be a String in your Bizagi model.
•org_id: ID of the organization a la que pertenece la persona. This parameter should be a number in your Bizagi model.
•email: email of the person. This parameter should be a String in your Bizagi model.
•phone: teléfono of the person. This parameter should be a String in your Bizagi model.
To configure the outputs of this action, you can map the output object to the corresponding entity in Bizagi. Make sure you map the attributes of the entity appropriately.
For more information about using this method, refer to Pipedrive 's official documentation at https://developers.pipedrive.com/docs/api/v1/#!/Persons.
Delete a person
This action deletes a person.
To configure its inputs, take into account the following descriptions:
•id (Required): ID of the person. This parameter should be a String in your Bizagi model.
To configure the outputs of this action, you can map the output object to the corresponding entity in Bizagi. Make sure you map the attributes of the entity appropriately.
For more information about using this method, refer to Pipedrive 's official documentation at https://developers.pipedrive.com/docs/api/v1/#!/Persons.
Update a person
This action updates the information of a person.
To configure its inputs, take into account the following descriptions:
•id (Required): ID of the person. This parameter should be a number in your Bizagi model.
•name: nombre of the person. This parameter should be a String in your Bizagi model.
•org_id: ID of the organization a la que pertenece la persona. This parameter should be a number in your Bizagi model.
•email: email of the person. This parameter should be a String in your Bizagi model.
•phone: teléfono of the person. This parameter should be a String in your Bizagi model.
To configure the outputs of this action, you can map the output object to the corresponding entity in Bizagi. Make sure you map the attributes of the entity appropriately.
For more information about using this method, refer to Pipedrive 's official documentation at https://developers.pipedrive.com/docs/api/v1/#!/Persons.
Get all persons
This action gets a list of persons. It can be filtered by the first letter of the name.
To configure its inputs, take into account the following descriptions:
•first_char: If provided, the list will contain only names that starts with this letter (it is no case sensitive). This parameter should be a String in your Bizagi model.
•start: index where the results start. This parameter should be a number in your Bizagi model.
•limit: number of record to fetch. This parameter should be a number in your Bizagi model.
To configure the outputs of this action, you can map the output object to the corresponding entity in Bizagi. Make sure you map the attributes of the entity appropriately.
For more information about using this method, refer to Pipedrive 's official documentation at https://developers.pipedrive.com/docs/api/v1/#!/Persons.
Get details of a person
This action gets detailed information of a person.
To configure its inputs, take into account the following descriptions:
•id (Required): ID of the person. This parameter should be a String in your Bizagi model.
To configure the outputs of this action, you can map the output object to the corresponding entity in Bizagi. Make sure you map the attributes of the entity appropriately.
For more information about using this method, refer to Pipedrive 's official documentation at https://developers.pipedrive.com/docs/api/v1/#!/Persons.
Find persons by name
This action gets a list of persons filtered by a keyword.
To configure its inputs, take into account the following descriptions:
•term (Required): keyword of the search. This parameter should be a String in your Bizagi model.
•org_id: ID of the organization/company. This parameter should be a number in your Bizagi model.
•start: index where the results start. This parameter should be a number in your Bizagi model.
•limit: number of record to fetch. This parameter should be a number in your Bizagi model.
To configure the outputs of this action, you can map the output object to the corresponding entity in Bizagi. Make sure you map the attributes of the entity appropriately.
For more information about using this method, refer to Pipedrive 's official documentation at https://developers.pipedrive.com/docs/api/v1/#!/Persons.
Add a note
This action adds a note to a person/deal/organization.
To configure its inputs, take into account the following descriptions:
•content (Required):: content of the note. This parameter should be a String in your Bizagi model.
•deal_id: ID of the deal of the note. This parameter should be a number in your Bizagi model.
•person_id: ID of the person of the note. This parameter should be a number in your Bizagi model.
•org_id: ID of the organization of the note. This parameter should be a number in your Bizagi model.
•pinned_to_deal_flag: selects if this note is marked as important in the deal. This parameter should be a number in your Bizagi model.
•pinned_to_organization_flag: selects if this note is marked as important in the organization. This parameter should be a number in your Bizagi model.
•pinned_to_person_flag: selects if this note is marked as important in the person. This parameter should be a number in your Bizagi model.
To configure the outputs of this action, you can map the output object to the corresponding entity in Bizagi. Make sure you map the attributes of the entity appropriately.
For more information about using this method, refer to Pipedrive 's official documentation at https://developers.pipedrive.com/docs/api/v1/#!/Notes.
Update a note
This action updatesa note.
To configure its inputs, take into account the following descriptions:
•id (Required): ID of the note. This parameter should be a number in your Bizagi model.
•content (Required):: content of the note. This parameter should be a String in your Bizagi model.
•deal_id: ID of the deal of the note. This parameter should be a number in your Bizagi model.
•person_id: ID of the person of the note. This parameter should be a number in your Bizagi model.
•org_id: ID of the organization of the note. This parameter should be a number in your Bizagi model.
•pinned_to_deal_flag: selects if this note is marked as important in the deal. This parameter should be a number in your Bizagi model.
•pinned_to_organization_flag: selects if this note is marked as important in the organization. This parameter should be a number in your Bizagi model.
•pinned_to_person_flag: selects if this note is marked as important in the person. This parameter should be a number in your Bizagi model.
To configure the outputs of this action, you can map the output object to the corresponding entity in Bizagi. Make sure you map the attributes of the entity appropriately.
For more information about using this method, refer to Pipedrive 's official documentation at https://developers.pipedrive.com/docs/api/v1/#!/Notes.
Get one note
This action gets the details of a note.
To configure its inputs, take into account the following descriptions:
•id (Required): ID of the note. This parameter should be a number in your Bizagi model.
To configure the outputs of this action, you can map the output object to the corresponding entity in Bizagi. Make sure you map the attributes of the entity appropriately.
For more information about using this method, refer to Pipedrive 's official documentation at https://developers.pipedrive.com/docs/api/v1/#!/Notes.
Delete a note
This action deletes a note.
To configure its inputs, take into account the following descriptions:
•id (Required): ID of the note. This parameter should be a String in your Bizagi model.
To configure the outputs of this action, you can map the output object to the corresponding entity in Bizagi. Make sure you map the attributes of the entity appropriately.
For more information about using this method, refer to Pipedrive 's official documentation at https://developers.pipedrive.com/docs/api/v1/#!/Notes.
Get all notes
This action gets a list of notes of a person/deal/organization.
To configure its inputs, take into account the following descriptions:
•user_id: ID of the user owner of the notes, if no information is provided all the notes are added to the list. This parameter should be a number in your Bizagi model.
•deal_id: ID of the deal of the notes, if no information is provided all the notes are added to the list. This parameter should be a number in your Bizagi model.
•person_id: ID of the person of the notes, if no information is provided all the notes are added to the list. This parameter should be a number in your Bizagi model.
•org_id: ID of the organization of the notes, if no information is provided all the notes are added to the list. This parameter should be a number in your Bizagi model.
•start: index where the results start. This parameter should be a number in your Bizagi model.
•limit: number of record to fetch. This parameter should be a number in your Bizagi model.
•start_date: start date of the search (YYYY-MM-DD). This parameter should be a date in your Bizagi model.
•end_date: end date of the search (YYYY-MM-DD). This parameter should be a date in your Bizagi model.
To configure the outputs of this action, you can map the output object to the corresponding entity in Bizagi. Make sure you map the attributes of the entity appropriately.
For more information about using this method, refer to Pipedrive 's official documentation at https://developers.pipedrive.com/docs/api/v1/#!/Notes.
Add a product
This action adds a new product to the system.
To configure its inputs, take into account the following descriptions:
•name (Required): name of the product. This parameter should be a String in your Bizagi model.
•code: code of the product. This parameter should be a String in your Bizagi model.
•unit: unit in which the product is sold. This parameter should be a String in your Bizagi model.
•tax: tax percentage. This parameter should be a number in your Bizagi model.
•active_flag: wheter the product is active (1 = active, 2 = inactive). This parameter should be a number in your Bizagi model.
•cost: cost of the product. This parameter should be a String in your Bizagi model.
•owner_id: ID of the user owner of the product. If no information is provided, the action uses the authenticated user. This parameter should be a number in your Bizagi model.
•prices: Object matrix, each one contains: currency (String), price (integer), cost (integer, optional), cost_header (integer, optional). You can only add a single price for each currency. When no price is provided, not prices will be set for the product
To configure the outputs of this action, you can map the output object to the corresponding entity in Bizagi. Make sure you map the attributes of the entity appropriately.
For more information about using this method, refer to Pipedrive 's official documentation at https://developers.pipedrive.com/docs/api/v1/#!/Products.
Update a product
This action updates the information of a product.
To configure its inputs, take into account the following descriptions:
•id (Required): ID of the product. This parameter should be a String in your Bizagi model.
•name (Required): name of the product. This parameter should be a String in your Bizagi model.
•code: code of the product. This parameter should be a String in your Bizagi model.
•unit: unit in which the product is sold. This parameter should be a String in your Bizagi model.
•tax: tax percentage. This parameter should be a number in your Bizagi model.
•active_flag: wheter the product is active (1 = active, 2 = inactive). This parameter should be a number in your Bizagi model.
•cost: cost of the product. This parameter should be a String in your Bizagi model.
•owner_id: ID of the user owner of the product. If no information is provided, the action uses the authenticated user. This parameter should be a number in your Bizagi model.
•prices: Object matrix, each one contains: currency (String), price (integer), cost (integer, optional), cost_header (integer, optional). You can only add a single price for each currency. When no price is provided, not prices will be set for the product
To configure the outputs of this action, you can map the output object to the corresponding entity in Bizagi. Make sure you map the attributes of the entity appropriately.
For more information about using this method, refer to Pipedrive 's official documentation at https://developers.pipedrive.com/docs/api/v1/#!/Products.
Delete a product
This action deletes a product.
To configure its inputs, take into account the following descriptions:
•id (Required): ID of the product. This parameter should be a String in your Bizagi model.
To configure the outputs of this action, you can map the output object to the corresponding entity in Bizagi. Make sure you map the attributes of the entity appropriately.
For more information about using this method, refer to Pipedrive 's official documentation at https://developers.pipedrive.com/docs/api/v1/#!/Products.
Get one product
This action gets detailed information of a product.
To configure its inputs, take into account the following descriptions:
•id (Required): ID of the product. This parameter should be a String in your Bizagi model.
To configure the outputs of this action, you can map the output object to the corresponding entity in Bizagi. Make sure you map the attributes of the entity appropriately.
For more information about using this method, refer to Pipedrive 's official documentation at https://developers.pipedrive.com/docs/api/v1/#!/Products.
Get deals where a product is attached to
This action gets a list of deals containin a product.
To configure its inputs, take into account the following descriptions:
•id (Required): ID of the product. This parameter should be a number in your Bizagi model.
•start: index where the results start. This parameter should be a number in your Bizagi model.
•limit: number of record to fetch. This parameter should be a number in your Bizagi model.
To configure the outputs of this action, you can map the output object to the corresponding entity in Bizagi. Make sure you map the attributes of the entity appropriately.
For more information about using this method, refer to Pipedrive 's official documentation at https://developers.pipedrive.com/docs/api/v1/#!/Products.
Find products by name
This action gets a list of products filtered by name.
To configure its inputs, take into account the following descriptions:
•term (Required): palabra clave o término de búsqueda. This parameter should be a String in your Bizagi model.
•currency: Código de la divisa en el que se deben devolver los precios. Si se omite, se devolverán los precios en la divisa predeterminada of the user.
•start: index where the results start. This parameter should be a number in your Bizagi model.
•limit: number of record to fetch. This parameter should be a number in your Bizagi model.
To configure the outputs of this action, you can map the output object to the corresponding entity in Bizagi. Make sure you map the attributes of the entity appropriately.
For more information about using this method, refer to Pipedrive 's official documentation at https://developers.pipedrive.com/docs/api/v1/#!/Products.
Get all products
This action gets a list of all the products.
To configure its inputs, take into account the following descriptions:
•start: index where the results start. This parameter should be a number in your Bizagi model.
•limit: number of record to fetch. This parameter should be a number in your Bizagi model.
To configure the outputs of this action, you can map the output object to the corresponding entity in Bizagi. Make sure you map the attributes of the entity appropriately.
For more information about using this method, refer to Pipedrive 's official documentation at https://developers.pipedrive.com/docs/api/v1/#!/Products.
Add a new pipeline
This action adds a new pipeline.
To configure its inputs, take into account the following descriptions:
•name (Required): name of the pipeline. This parameter should be a String in your Bizagi model.
•deal_probability: indicates if the probability of the deal is enabled for this pipeline. This parameter should be a number in your Bizagi model.
•order_nr: Define the orden of the pipelines. The first order (order_nr = 0) is the default pipeline. This parameter should be a number in your Bizagi model.
•active: Whetet the pipline is inactive (hidden) or active. This parameter should be a number in your Bizagi model.
To configure the outputs of this action, you can map the output object to the corresponding entity in Bizagi. Make sure you map the attributes of the entity appropriately.
For more information about using this method, refer to Pipedrive 's official documentation at https://developers.pipedrive.com/docs/api/v1/#!/Pipelines.
Edit a pipeline
This action updatesthe information of a pipeline.
To configure its inputs, take into account the following descriptions:
•id (Required): ID del pipeline. This parameter should be a number in your Bizagi model.
•name (Required): name of the pipeline. This parameter should be a String in your Bizagi model.
•deal_probability: indicates if the probability of the deal is enabled for this pipeline. This parameter should be a number in your Bizagi model.
•order_nr: Define the orden of the pipelines. The first order (order_nr = 0) is the default pipeline. This parameter should be a number in your Bizagi model.
•active: Whetet the pipline is inactive (hidden) or active. This parameter should be a number in your Bizagi model.
To configure the outputs of this action, you can map the output object to the corresponding entity in Bizagi. Make sure you map the attributes of the entity appropriately.
For more information about using this method, refer to Pipedrive 's official documentation at https://developers.pipedrive.com/docs/api/v1/#!/Pipelines.
Delete a pipeline
This action deletes a pipeline.
To configure its inputs, take into account the following descriptions:
•id (Required): ID del pipeline. This parameter should be a number in your Bizagi model.
To configure the outputs of this action, you can map the output object to the corresponding entity in Bizagi. Make sure you map the attributes of the entity appropriately.
For more information about using this method, refer to Pipedrive 's official documentation at https://developers.pipedrive.com/docs/api/v1/#!/Pipelines.
Get all pipelines
This action gets a list of pipelines.
You don't need to provide any input for this action.
To configure the outputs of this action, you can map the output object to the corresponding entity in Bizagi. Make sure you map the attributes of the entity appropriately.
For more information about using this method, refer to Pipedrive 's official documentation at https://developers.pipedrive.com/docs/api/v1/#!/Pipelines.
Get one pipeline
This action gets the information of a pipeline.
To configure its inputs, take into account the following descriptions:
•id (Required): ID del pipeline. This parameter should be a number in your Bizagi model.
•totals_convert_currency: Código de divisa de 3 letras. Puede establecer este parámetro en 'default_currency' se usa la moneda predeterminada of the user. This parameter should be a String in your Bizagi model.
To configure the outputs of this action, you can map the output object to the corresponding entity in Bizagi. Make sure you map the attributes of the entity appropriately.
For more information about using this method, refer to Pipedrive 's official documentation at https://developers.pipedrive.com/docs/api/v1/#!/Pipelines.
Get deals in a pipeline
This action gets the deals of a pipeline.
To configure its inputs, take into account the following descriptions:
•id (Required): ID del pipeline. This parameter should be a number in your Bizagi model.
•user_id: If provided only deals of the provided user are shown. If no information is provided the action uses the authenticated user. This parameter should be a number in your Bizagi model.
•stage_id: If provided only deals in the provided stage are shown. If no information is provided the action uses the authenticated user. This parameter should be a number in your Bizagi model.
•start: index where the results start. This parameter should be a number in your Bizagi model.
•limit: number of record to fetch. This parameter should be a number in your Bizagi model.
To configure the outputs of this action, you can map the output object to the corresponding entity in Bizagi. Make sure you map the attributes of the entity appropriately.
For more information about using this method, refer to Pipedrive 's official documentation at https://developers.pipedrive.com/docs/api/v1/#!/Pipelines.
Add a new stage
This action adds a new stage to a pipeline.
To configure its inputs, take into account the following descriptions:
•name (Required): name of the stage. This parameter should be a String in your Bizagi model.
•pipeline_id (Required): ID del pipeline. This parameter should be a number in your Bizagi model.
•deal_probability: percentage of the probability of success. Used/shown when the ponderated values of the deal are used. This parameter should be a number in your Bizagi model.
•rotten_flag: wheter the deals in this stage can become rotten. This parameter should be a number in your Bizagi model.
•rotten_days: Number of days after which the deal is concidered rotten. Only use it if the rotten_flag field is active. This parameter should be a number in your Bizagi model.
To configure the outputs of this action, you can map the output object to the corresponding entity in Bizagi. Make sure you map the attributes of the entity appropriately.
For more information about using this method, refer to Pipedrive 's official documentation at https://developers.pipedrive.com/docs/api/v1/#!/Stages.
Update stage details
This action updates the information of a stage.
To configure its inputs, take into account the following descriptions:
•id (Required): ID of the stage. This parameter should be a number in your Bizagi model.
•name (Required): name of the stage. This parameter should be a String in your Bizagi model.
•pipeline_id (Required): ID del pipeline. This parameter should be a number in your Bizagi model.
•deal_probability: percentage of the probability of success. Used/shown when the ponderated values of the deal are used. This parameter should be a number in your Bizagi model.
•rotten_flag: wheter the deals in this stage can become rotten. This parameter should be a number in your Bizagi model.
•rotten_days: Number of days after which the deal is concidered rotten. Only use it if the rotten_flag field is active. This parameter should be a number in your Bizagi model.
To configure the outputs of this action, you can map the output object to the corresponding entity in Bizagi. Make sure you map the attributes of the entity appropriately.
For more information about using this method, refer to Pipedrive 's official documentation at https://developers.pipedrive.com/docs/api/v1/#!/Stages.
Get one stage
This action gets detailed information of a stage.
To configure its inputs, take into account the following descriptions:
•id (Required): ID of the stage. This parameter should be a number in your Bizagi model.
To configure the outputs of this action, you can map the output object to the corresponding entity in Bizagi. Make sure you map the attributes of the entity appropriately.
For more information about using this method, refer to Pipedrive 's official documentation at https://developers.pipedrive.com/docs/api/v1/#!/Stages.
Delete a stage
This action deletes a stage.
To configure its inputs, take into account the following descriptions:
•id (Required): ID of the stage. This parameter should be a number in your Bizagi model.
To configure the outputs of this action, you can map the output object to the corresponding entity in Bizagi. Make sure you map the attributes of the entity appropriately.
For more information about using this method, refer to Pipedrive 's official documentation at https://developers.pipedrive.com/docs/api/v1/#!/Stages.
Get all stages
This action gets a list of stages filtered by pipeline id.
To configure its inputs, take into account the following descriptions:
•pipeline_id: permite filtrar las etapas de un pipeline. Si se omite traerá todas las etapas disponibles. This parameter should be a number in your Bizagi model.
To configure the outputs of this action, you can map the output object to the corresponding entity in Bizagi. Make sure you map the attributes of the entity appropriately.
For more information about using this method, refer to Pipedrive 's official documentation at https://developers.pipedrive.com/docs/api/v1/#!/Stages.
Get deals in a stage
This action gets a list of deals in a stage.
To configure its inputs, take into account the following descriptions:
•id (Required): ID of the stage. This parameter should be a number in your Bizagi model.
•user_id: If provided only deals of the provided user are shown. If no information is provided the action uses the authenticated user. This parameter should be a number in your Bizagi model.
•everyone: If provided only deals associated for everyone. If no information is provided the action uses the authenticated user. This parameter should be a number in your Bizagi model.
•start: index where the results start. This parameter should be a number in your Bizagi model.
•limit: number of record to fetch. This parameter should be a number in your Bizagi model.
To configure the outputs of this action, you can map the output object to the corresponding entity in Bizagi. Make sure you map the attributes of the entity appropriately.
For more information about using this method, refer to Pipedrive 's official documentation at https://developers.pipedrive.com/docs/api/v1/#!/Stages.
Last Updated 10/27/2022 11:33:57 AM