Pipedrive

subject

Subject of the activity

type

Type of the activity. This is in correlation with the `key_string` parameter of ActivityTypes.

ownerId

ID of the user whom the activity will be assigned to. If omitted, the activity will be assigned to the authorized user.

dealId

ID of the deal this activity will be associated with

leadId

ID of the lead this activity will be associated with

orgId

ID of the organization this activity will be associated with

projectId

ID of the project this activity will be associated with

dueDate

Due date of the activity. Format: `YYYY-MM-DD`

dueTime

Due time of the activity in UTC. Format: `HH:MM`

duration

Duration of the activity. Format: `HH:MM`

busy

Set the activity as

done

Whether the activity is done or not.

location

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

participants

List of multiple persons (participants) this activity will be associated with. If omitted, single participant from `person_id` field is used. It requires a structure as follows: `[{\

attendees

Attendees of the activity. This can be either your existing Pipedrive contacts or an external email address. It requires a structure as follows: `[{\

publicDescription

Additional details about the activity that will be synced to your external calendar. Unlike the note added to the activity, the description will be publicly visible to any guests added to the activity.

note

Note of the activity (HTML format)

title

Deal title

ownerId

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

personId

ID of the person this deal will be associated with

orgId

ID of the organization this deal will be associated with

pipelineId

ID of the pipeline this activity will be associated with

stageId

ID of the stage this deal will be placed in a pipeline (note that you can

value

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

currency

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

status

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

probability

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

lostReason

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

visibleTo

Visibility of the deal. If omitted, visibility will be set to the default visibility setting of this item type for the authorized user.

title

The name of the lead

personId

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.

organizationId

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.

ownerId

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.

leadLabelIds

The IDs of the lead labels to associate with the lead

value

Potential value of the lead, e.g. `{ \

expectedCloseDate

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.

visibleTo

The visibility of the lead. If omitted, the visibility will be set to the default visibility setting of this item type for the authorized user. Read more about visibility groups [here](https://support.pipedrive.com/en/article/visibility-groups).

wasSeen

A flag indicating whether the lead was seen by someone in the Pipedrive UI

note

A note to add to the lead

content

The content of the note in HTML format. Subject to sanitization on the back-end.

leadId

The ID of the lead the note will be attached to. This property is required unless one of (deal_id/person_id/org_id) is specified.

dealId

The ID of the deal the note will be attached to. This property is required unless one of (lead_id/person_id/org_id) is specified.

personId

The ID of the person this note will be attached to. This property is required unless one of (deal_id/lead_id/org_id) is specified.

organizationId

The ID of the organization this note will be attached to. This property is required unless one of (deal_id/lead_id/person_id) is specified.

userId

The ID of the user who will be marked as the author of the note. Only an admin can change the author.

addTime

The creation date and time of the deal. Requires admin user API token. Format: `YYYY-MM-DDTHH:MM:SSZ`

pinnedToDealFlag

If set, the results are filtered by note to deal pinning state (deal_id is also required)

pinnedToLeadFlag

If set, the results are filtered by note to lead pinning state (lead_id is also required)

pinnedToOrgFlag

If set, the results are filtered by note to organization pinning state (org_id is also required)

pinnedToPersonFlag

If set, the results are filtered by note to person pinning state (person_id is also required)

name

Organization name

ownerId

ID of the user who will be marked as the owner of this organization. When omitted, the authorized user ID will be used.

visibleTo

Visibility of the organization. If omitted, visibility will be set to the default visibility setting of this item type for the authorized user.

name

Person name

ownerId

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

organizationId

ID of the organization this person will belong to.

emails

Email addresses (one or more) associated with the person, presented in the same manner as received by GET request of a person. **Example: {\

phones

Phone numbers (one or more) associated with the person, presented in the same manner as received by GET request of a person. **Example: {\

visibleTo

Visibility of the person. If omitted, visibility will be set to the default visibility setting of this item type for the authorized user.

leadId

The ID of the lead to get

personId

The ID of the person to get details for.

leadId

The ID of the lead that the notes are attached to

dealId

The ID of the deal that the notes are attached to

personId

The ID of the person that the notes are attached to

organizationId

The ID of the organization that the notes are attached to

userId

The ID of the user that the notes are attached to

projectId

The ID of the project that the notes are attached to

keyword

Only remove duplicate notes that contain the specified keyword(s)

term

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

exactMatch

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

fields

An array containing fields to perform the search from. Defaults to all of them.

personId

Will filter leads by the provided Person ID

organizationId

Will filter leads by the provided Organization ID

includeFields

Supports including optional fields in the results which are not provided by default.

searchTerm

The term to search for in the note content

leadId

The ID of the lead that the note is attached to

dealId

The ID of the deal that the note is attached to

personId

The ID of the person that the note is attached to

organizationId

The ID of the organization that the note is attached to

userId

The ID of the user that the note is attached to

projectId

The ID of the project that the note is attached to

sortField

The field name to sort by

sortDirection

The direction to sort the results in

startDate

The date in format of YYYY-MM-DD from which notes to fetch

endDate

The date in format of YYYY-MM-DD until which notes to fetch to

pinnedToLeadFlag

If `true`, the results are filtered by note to lead pinning state

pinnedToDealFlag

If `true`, the results are filtered by note to deal pinning state

pinnedToOrganizationFlag

If `true`, the results are filtered by note to organization pinning state

pinnedToPersonFlag

If `true`, the results are filtered by note to person pinning state

pinnedToProjectFlag

If `true`, the results are filtered by note to project pinning state

maxResults

The maximum number of results to return

term

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

fields

An array containing fields to perform the search from. Defaults to all of them.

exactMatch

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

organizationId

Will filter Deals by the provided Organization ID. The upper limit of found Deals associated with the Organization is 2000.

includeFields

Supports including optional fields in the results which are not provided by default.

start

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

Items shown per page.

dealId

ID of the deal

title

Deal title

ownerId

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

personId

ID of the person this deal will be associated with

orgId

ID of the organization this deal will be associated with

pipelineId

ID of the pipeline this activity will be associated with

stageId

ID of the stage this deal will be placed in a pipeline (note that you can

value

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

currency

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

status

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

probability

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

lostReason

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

visibleTo

Visibility of the deal. If omitted, visibility will be set to the default visibility setting of this item type for the authorized user.

note

A note to add to the deal

personId

The ID of the person to update

name

New name of the person

ownerId

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

organizationId

ID of the organization this person will belong to

emails

Email addresses (one or more) associated with the person, presented in the same manner as received by GET request of a person. **Example: {\

phones

Phone numbers (one or more) associated with the person, presented in the same manner as received by GET request of a person. **Example: {\

visibleTo

Visibility of the person. If omitted, visibility will be set to the default visibility setting of this item type for the authorized user.