Skip to content

How to Manage Pipedrive Records from HappyFox Workflows

Last updated

This article covers every workflow action available through the Pipedrive integration — creating and updating people, organizations, deals, and activities, plus searching across Pipedrive records.

Validation note legend

Term Meaning
Required The workflow will not run this action if the field is missing or blank.
Optional The field can be left empty; the action will still run.
Text A plain text string.
Number A numeric (integer) value, entered as a number.
Yes/No toggle A boolean true/false switch.
List (multiple entries) One or more structured objects or values.

Person Actions

Add a Person in Pipedrive

Creates a new person (contact) record in Pipedrive. The only required detail is the person's name — all other contact fields are optional.

Field Description Validation
Name The full name of the person to create. Required · Text
Owner ID The ID of the Pipedrive user who will own this person record. Optional · Number
Organization ID The ID of the Pipedrive organization to link this person to. Optional · Number
Email One or more email addresses for this person. Each entry is an email object (for example, {"value": "[email protected]", "primary": true}). Optional · List (multiple entries)
Phone One or more phone numbers for this person. Each entry is a phone object (for example, {"value": "+1234567890", "primary": true}). Optional · List (multiple entries)
Visible To Controls who can see this person record in Pipedrive. Accepted values: 1 (owner only) or 3 (everyone). Optional · Number
Extra Fields Custom field values to set on the person record. Each entry maps a Pipedrive custom field key to its value. Optional · List (multiple entries)

Update a Person in Pipedrive

Updates an existing person record, identified by its ID. Only the fields you provide are changed; all other existing data is left untouched.

Field Description Validation
ID The Pipedrive ID of the person to update. Required · Number
Name The updated full name for the person. Optional · Text
Owner ID The ID of the Pipedrive user who should own this record. Optional · Number
Organization ID The ID of the organization to link this person to. Optional · Number
Email Updated email address list for this person. Each entry is an email object. Optional · List (multiple entries)
Phone Updated phone number list for this person. Each entry is a phone object. Optional · List (multiple entries)
Visible To Controls who can see this person record. Accepted values: 1 (owner only) or 3 (everyone). Optional · Number
Extra Fields Custom field values to update on the person record. Optional · List (multiple entries)

Organization Actions

Add an Organization in Pipedrive

Creates a new organization record in Pipedrive. The organization's name is the only required field.

Field Description Validation
Name The name of the organization to create. Required · Text
Owner ID The Pipedrive user ID who will own this organization. Optional · Text
Visible To Controls who can see this organization. Accepted values: 1 (owner only) or 3 (everyone). Optional · Text
Extra Fields Custom field values to set on the organization record. Optional · List (multiple entries)

Update an Organization in Pipedrive

Updates an existing organization record, identified by its ID. Only the fields you supply are changed.

Field Description Validation
ID The Pipedrive ID of the organization to update. Required · Number
Name The updated name for the organization. Optional · Text
Owner ID The ID of the Pipedrive user who should own this record. Optional · Number
Visible To Controls who can see this organization. Accepted values: 1 (owner only) or 3 (everyone). Optional · Number
Extra Fields Custom field values to update on the organization record. Optional · List (multiple entries)

Deal Actions

Add a Deal in Pipedrive

Creates a new deal record in Pipedrive. Only the deal title is required — all other details are optional.

Field Description Validation
Title The name or title of the deal to create. Required · Text
Value The monetary value of the deal (for example, 5000). Optional · Text (numeric string)
Currency The 3-letter ISO currency code for the deal value (for example, USD, EUR). Optional · Text
User ID The ID of the Pipedrive user who will own this deal. Optional · Number
Person ID The ID of the person (contact) to link to this deal. Optional · Number
Organization ID The ID of the organization to link to this deal. Optional · Number
Stage ID The ID of the pipeline stage to place this deal in. Optional · Number
Status The current status of the deal. Typical values: open, won, lost, deleted. Optional · Text
Probability The win probability of the deal as a percentage (0–100). Optional · Text (numeric string)
Lost Reason The reason the deal was lost. Relevant when Status is lost. Optional · Text
Visible To Controls who can see this deal. Accepted values: 1 (owner only) or 3 (everyone). Optional · Number
Extra Fields Custom field values to set on the deal record. Optional · List (multiple entries)

Update Deal in Pipedrive

Updates an existing deal record, identified by its ID. Only the fields you supply are changed; all other deal data remains as-is.

Field Description Validation
ID The Pipedrive ID of the deal to update. Required · Number
Title The updated title for the deal. Optional · Text
Value The updated monetary value of the deal. Optional · Text (numeric string)
Currency The updated 3-letter ISO currency code. Optional · Text
User ID The updated owner (Pipedrive user ID) for this deal. Optional · Number
Person ID The updated linked person ID. Optional · Number
Organization ID The updated linked organization ID. Optional · Number
Stage ID The updated pipeline stage ID. Optional · Number
Status The updated deal status. Typical values: open, won, lost, deleted. Optional · Text
Probability The updated win probability (0–100). Optional · Text (numeric string)
Lost Reason The updated reason for losing the deal. Optional · Text
Visible To Controls who can see this deal. Accepted values: 1 (owner only) or 3 (everyone). Optional · Number
Extra Fields Custom field values to update on the deal record. Optional · List (multiple entries)

Activity Actions

Add an Activity in Pipedrive

Creates a new activity — such as a call, meeting, email, or task — in Pipedrive. Both the subject and activity type are required; all other scheduling and association fields are optional.

Field Description Validation
Subject The title or subject of the activity. Required · Text
Type The activity type key (for example, call, meeting, email, task). Must match a valid activity type configured in your Pipedrive account. Required · Text
Done Whether the activity is already completed. Accepted values: 0 (not done) or 1 (done). Optional · Text
Due Date The date the activity is due (YYYY-MM-DD). Optional · Text
Due Time The time the activity is due, in UTC (HH:MM). Optional · Text
Duration How long the activity is expected to take (HH:MM). Optional · Text
User ID The ID of the Pipedrive user responsible for this activity. Optional · Number
Deal ID The ID of the deal to link this activity to. Optional · Number
Person ID The ID of the person (contact) to link this activity to. Optional · Number
Participants Additional people involved in the activity. Each row includes person_id (the Pipedrive ID of the participant) and primary_flag (whether this participant is the primary contact). Optional · List (multiple entries)
Organization ID The ID of the organization to link this activity to. Optional · Number
Note A text note or description attached to the activity. Optional · Text
Location The physical or virtual location of the activity. Optional · Text
Public Description A description visible to all participants. Optional · Text
Busy Flag Whether the assigned user should be marked as busy during this activity. Optional · Yes/No toggle
Attendees People attending the activity (for example, for calendar events). Each entry is an attendee object. Optional · List (multiple entries)
Extra Fields Custom field values to set on the activity record. Optional · List (multiple entries)

Update an Activity in Pipedrive

Updates an existing activity, identified by its ID. The activity ID, subject, and type are all required; all other fields update only the values you provide.

Field Description Validation
ID The Pipedrive ID of the activity to update. Required · Number
Subject The updated subject/title of the activity. Required · Text
Type The updated activity type key. Must match a valid activity type in your Pipedrive account. Required · Text
Done Whether the activity should be marked as completed. Accepted values: 0 (not done) or 1 (done). Optional · Text
Due Date The updated due date (YYYY-MM-DD). Optional · Text
Due Time The updated due time in UTC (HH:MM). Optional · Text
Duration The updated expected duration (HH:MM). Optional · Text
User ID The updated responsible user ID. Optional · Number
Deal ID The updated linked deal ID. Optional · Number
Person ID The updated linked person ID. Optional · Number
Participants Updated list of people involved in the activity. Each row includes person_id and primary_flag. Optional · List (multiple entries)
Organization ID The updated linked organization ID. Optional · Number
Note An updated note for the activity. HTML formatting is accepted. Optional · Text
Location The updated location. Optional · Text
Public Description The updated public description. Optional · Text
Busy Flag Whether the user should be marked as busy during this activity. Optional · Yes/No toggle
Attendees Updated attendee list. Optional · List (multiple entries)
Extra Fields Custom field values to update on the activity record. Optional · List (multiple entries)

Search Actions

Perform a Search from Multiple Item Types

Searches across Pipedrive for items — deals, people, organizations, and more — matching a keyword or phrase, and returns a list of matching results.

Field Description Validation
Term The keyword or phrase to search for. Minimum 2 characters, or 1 character when Exact Match is enabled. Required · Text
Item Types The Pipedrive item types to search within, as a comma-separated string (for example, deal,person,organization,product,file,activity). Optional · Text
Fields The specific fields to search within for each item type, as a comma-separated string. Optional · Text
Search For Related Items When enabled, Pipedrive also returns items related to the direct matches. Optional · Yes/No toggle
Exact Match When enabled, only items that match the term exactly (case-insensitive) are returned, and a single-character term is allowed. Optional · Yes/No toggle
Include Fields Additional fields to include in the result objects beyond the defaults, as a comma-separated string. Optional · Text
Start Pagination offset — the index of the first result to return (0-based). Optional · Number
Limit The maximum number of results to return in a single call. Optional · Number

Your workflow can now create, update, and search Pipedrive people, organizations, deals, and activities. Next, see how to add an action to a workflow to use one of these actions as a step in your workflow builder.