/pipedrive-contacts | Type: Application | PCID required: Yes
Tools
pipedrive_contacts_add_organization
Add a new organization Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
add_time | string | No | — | The creation date and time of the organization |
address | object | No | — | The address of the organization |
custom_fields | object | No | — | An object where each key represents a custom field. All custom fields are referenced as randomly generated 40-character hashes |
label_ids | integer[] | No | — | The IDs of labels assigned to the organization |
name | string | Yes | — | The name of the organization |
owner_id | integer | No | — | The ID of the user who owns the organization |
update_time | string | No | — | The last updated date and time of the organization |
visible_to | integer | No | — | The visibility of the organization |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"add_time": {
"type": "string",
"description": "The creation date and time of the organization"
},
"address": {
"type": "object",
"description": "The address of the organization",
"properties": {
"value": {
"type": "string",
"description": "The full address of the organization"
},
"country": {
"type": "string",
"description": "Country of the organization"
},
"admin_area_level_1": {
"type": "string",
"description": "Admin area level 1 (e.g. state) of the organization"
},
"admin_area_level_2": {
"type": "string",
"description": "Admin area level 2 (e.g. county) of the organization"
},
"locality": {
"type": "string",
"description": "Locality (e.g. city) of the organization"
},
"sublocality": {
"type": "string",
"description": "Sublocality (e.g. neighborhood) of the organization"
},
"route": {
"type": "string",
"description": "Route (e.g. street) of the organization"
},
"street_number": {
"type": "string",
"description": "Street number of the organization"
},
"subpremise": {
"type": "string",
"description": "Subpremise (e.g. apartment/suite number) of the organization"
},
"postal_code": {
"type": "string",
"description": "Postal code of the organization"
}
}
},
"custom_fields": {
"type": "object",
"description": "An object where each key represents a custom field. All custom fields are referenced as randomly generated 40-character hashes"
},
"label_ids": {
"type": "array",
"items": {
"type": "integer"
},
"description": "The IDs of labels assigned to the organization"
},
"name": {
"type": "string",
"description": "The name of the organization"
},
"owner_id": {
"type": "integer",
"description": "The ID of the user who owns the organization"
},
"update_time": {
"type": "string",
"description": "The last updated date and time of the organization"
},
"visible_to": {
"type": "integer",
"description": "The visibility of the organization"
}
},
"required": [
"PCID",
"name"
]
}
pipedrive_contacts_add_organization_field
Create one organization field Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
field_name | string | Yes | — | Field name |
field_type | string | Yes | — | The type of the field<table><tr><th>Value</th><th>Description</th></tr><tr><td>varchar</td><td>Text (up to 255 characters)</td><tr><td>varchar_auto</td><td>Autocomplete text (up to 255 characters)</td><tr><td>text</td><td>Long text (up to 65k characters)</td><tr><td>double</td><td>Numeric value</td><tr><td>monetary</td><td>Monetary field (has a numeric value and a currency value)</td><tr><td>date</td><td>Date (format YYYY-MM-DD)</td><tr><td>set</td><td>Options field with a possibility of having multiple chosen options</td><tr><td>enum</td><td>Options field with a single possible chosen option</td><tr><td>user</td><td>User field (contains a user ID of another Pipedrive user)</td><tr><td>org</td><td>Organization field (contains an organization ID which is stored on the same account)</td><tr><td>people</td><td>Person field (contains a person ID which is stored on the same account)</td><tr><td>phone</td><td>Phone field (up to 255 numbers and/or characters)</td><tr><td>time</td><td>Time field (format HH:MM:SS)</td><tr><td>timerange</td><td>Time-range field (has a start time and end time value, both HH:MM:SS)</td><tr><td>daterange</td><td>Date-range field (has a start date and end date value, both YYYY-MM-DD)</td><tr><td>address</td><td>Address field</dd></table> |
important_fields | object | No | — | Configuration for highlighting the field at specific stages. |
options | object[] | No | — | Field options (required for enum and set field types) |
required_fields | object | No | — | Required fields configuration for marking the field as mandatory when interacted with in the Pipedrive web UI. |
ui_visibility | object | No | — | UI visibility settings for the field. Controls where the field appears in the Pipedrive web UI. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"field_name": {
"type": "string",
"description": "Field name"
},
"field_type": {
"type": "string",
"description": "The type of the field<table><tr><th>Value</th><th>Description</th></tr><tr><td>`varchar`</td><td>Text (up to 255 characters)</td><tr><td>`varchar_auto`</td><td>Autocomplete text (up to 255 characters)</td><tr><td>`text`</td><td>Long text (up to 65k characters)</td><tr><td>`double`</td><td>Numeric value</td><tr><td>`monetary`</td><td>Monetary field (has a numeric value and a currency value)</td><tr><td>`date`</td><td>Date (format YYYY-MM-DD)</td><tr><td>`set`</td><td>Options field with a possibility of having multiple chosen options</td><tr><td>`enum`</td><td>Options field with a single possible chosen option</td><tr><td>`user`</td><td>User field (contains a user ID of another Pipedrive user)</td><tr><td>`org`</td><td>Organization field (contains an organization ID which is stored on the same account)</td><tr><td>`people`</td><td>Person field (contains a person ID which is stored on the same account)</td><tr><td>`phone`</td><td>Phone field (up to 255 numbers and/or characters)</td><tr><td>`time`</td><td>Time field (format HH:MM:SS)</td><tr><td>`timerange`</td><td>Time-range field (has a start time and end time value, both HH:MM:SS)</td><tr><td>`daterange`</td><td>Date-range field (has a start date and end date value, both YYYY-MM-DD)</td><tr><td>`address`</td><td>Address field</dd></table>",
"enum": [
"varchar",
"text",
"double",
"phone",
"date",
"daterange",
"time",
"timerange",
"set",
"enum",
"varchar_auto",
"address",
"monetary",
"org",
"people",
"user"
]
},
"important_fields": {
"type": "object",
"description": "Configuration for highlighting the field at specific stages.",
"properties": {
"enabled": {
"type": "boolean",
"description": "Whether the field is marked as important. When false, the field is not highlighted. When true with empty stage_ids, the field is important everywhere. When true with specific stage_ids, the field is important only at those deal stages. Default is false."
},
"stage_ids": {
"type": "array",
"items": {
"type": "integer"
},
"description": "Array of deal stage IDs where this organization field should be highlighted as important. Must reference valid, active deal stages. Empty array when enabled is false."
}
}
},
"options": {
"type": "array",
"items": {
"type": "object",
"properties": {
"label": {
"type": "string",
"description": "The option label"
}
},
"required": [
"label"
]
},
"description": "Field options (required for enum and set field types)"
},
"required_fields": {
"type": "object",
"description": "Required fields configuration for marking the field as mandatory when interacted with in the Pipedrive web UI.",
"properties": {
"enabled": {
"type": "boolean",
"description": "Whether the field is required. When false, the field is optional. When true, the field is required when creating or updating organizations. Default is false."
}
}
},
"ui_visibility": {
"type": "object",
"description": "UI visibility settings for the field. Controls where the field appears in the Pipedrive web UI.",
"properties": {
"add_visible_flag": {
"type": "boolean",
"description": "Whether the field is shown in the add organization modal. Default is false. Cannot be set to false for the 'name' system field."
},
"details_visible_flag": {
"type": "boolean",
"description": "Whether the field is shown in the organization details view. Default is true."
},
"show_in_add_deal_dialog": {
"type": "object",
"description": "Configuration for showing this organization field when adding a new deal. Only available for custom fields or specific eligible system fields. Default is show=false, order=null."
},
"show_in_add_person_dialog": {
"type": "object",
"description": "Configuration for showing this organization field when adding a new person. Only available for custom fields or specific eligible system fields. Default is show=false, order=null."
}
}
}
},
"required": [
"PCID",
"field_name",
"field_type"
]
}
pipedrive_contacts_add_organization_field_options
Add organization field options in bulk Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
field_code | string | Yes | — | The unique code identifying the field |
body | object[] | Yes | — | Array of options to add. Each item must contain a label. At least one option is required. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"field_code": {
"type": "string",
"description": "The unique code identifying the field"
},
"body": {
"type": "array",
"items": {
"type": "object",
"properties": {
"label": {
"type": "string",
"description": "The display label for the new option"
}
},
"required": [
"label"
]
},
"description": "Array of options to add. Each item must contain a label. At least one option is required."
}
},
"required": [
"PCID",
"field_code",
"body"
]
}
pipedrive_contacts_add_organization_follower
Add a follower to an organization Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The ID of the organization |
user_id | integer | Yes | — | The ID of the user to add as a follower |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The ID of the organization"
},
"user_id": {
"type": "integer",
"description": "The ID of the user to add as a follower"
}
},
"required": [
"PCID",
"id",
"user_id"
]
}
pipedrive_contacts_add_person
Add a new person Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
add_time | string | No | — | The creation date and time of the person |
custom_fields | object | No | — | An object where each key represents a custom field. All custom fields are referenced as randomly generated 40-character hashes |
emails | object[] | No | — | The emails of the person |
label_ids | integer[] | No | — | The IDs of labels assigned to the person |
marketing_status | string | No | — | If the person does not have a valid email address, then the marketing status is not set and no_consent is returned for the marketing_status value when the new person is created. If the change is forbidden, the status will remain unchanged for every call that tries to modify the marketing status. Please be aware that it is only allowed once to change the marketing status from an old status to a new one.<table><tr><th>Value</th><th>Description</th></tr><tr><td>no_consent</td><td>The customer has not given consent to receive any marketing communications</td></tr><tr><td>unsubscribed</td><td>The customers have unsubscribed from ALL marketing communications</td></tr><tr><td>subscribed</td><td>The customers are subscribed and are counted towards marketing caps</td></tr><tr><td>archived</td><td>The customers with subscribed status can be moved to archived to save consent, but they are not paid for</td></tr></table> |
name | string | Yes | — | The name of the person |
org_id | integer | No | — | The ID of the organization linked to the person |
owner_id | integer | No | — | The ID of the user who owns the person |
phones | object[] | No | — | The phones of the person |
update_time | string | No | — | The last updated date and time of the person |
visible_to | integer | No | — | The visibility of the person |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"add_time": {
"type": "string",
"description": "The creation date and time of the person"
},
"custom_fields": {
"type": "object",
"description": "An object where each key represents a custom field. All custom fields are referenced as randomly generated 40-character hashes"
},
"emails": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "The email address of the person"
},
"primary": {
"type": "boolean",
"description": "Whether the email is primary or not"
},
"label": {
"type": "string",
"description": "The email address classification label"
}
}
},
"description": "The emails of the person"
},
"label_ids": {
"type": "array",
"items": {
"type": "integer"
},
"description": "The IDs of labels assigned to the person"
},
"marketing_status": {
"type": "string",
"description": "If the person does not have a valid email address, then the marketing status is **not set** and `no_consent` is returned for the `marketing_status` value when the new person is created. If the change is forbidden, the status will remain unchanged for every call that tries to modify the marketing status. Please be aware that it is only allowed **once** to change the marketing status from an old status to a new one.<table><tr><th>Value</th><th>Description</th></tr><tr><td>`no_consent`</td><td>The customer has not given consent to receive any marketing communications</td></tr><tr><td>`unsubscribed`</td><td>The customers have unsubscribed from ALL marketing communications</td></tr><tr><td>`subscribed`</td><td>The customers are subscribed and are counted towards marketing caps</td></tr><tr><td>`archived`</td><td>The customers with `subscribed` status can be moved to `archived` to save consent, but they are not paid for</td></tr></table>",
"enum": [
"no_consent",
"unsubscribed",
"subscribed",
"archived"
]
},
"name": {
"type": "string",
"description": "The name of the person"
},
"org_id": {
"type": "integer",
"description": "The ID of the organization linked to the person"
},
"owner_id": {
"type": "integer",
"description": "The ID of the user who owns the person"
},
"phones": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "The phone number of the person"
},
"primary": {
"type": "boolean",
"description": "Whether the phone number is primary or not"
},
"label": {
"type": "string",
"description": "The phone number classification label"
}
}
},
"description": "The phones of the person"
},
"update_time": {
"type": "string",
"description": "The last updated date and time of the person"
},
"visible_to": {
"type": "integer",
"description": "The visibility of the person"
}
},
"required": [
"PCID",
"name"
]
}
pipedrive_contacts_add_person_field
Create one person field Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
field_name | string | Yes | — | Field name |
field_type | string | Yes | — | The type of the field<table><tr><th>Value</th><th>Description</th></tr><tr><td>varchar</td><td>Text (up to 255 characters)</td><tr><td>varchar_auto</td><td>Autocomplete text (up to 255 characters)</td><tr><td>text</td><td>Long text (up to 65k characters)</td><tr><td>double</td><td>Numeric value</td><tr><td>monetary</td><td>Monetary field (has a numeric value and a currency value)</td><tr><td>date</td><td>Date (format YYYY-MM-DD)</td><tr><td>set</td><td>Options field with a possibility of having multiple chosen options</td><tr><td>enum</td><td>Options field with a single possible chosen option</td><tr><td>user</td><td>User field (contains a user ID of another Pipedrive user)</td><tr><td>org</td><td>Organization field (contains an organization ID which is stored on the same account)</td><tr><td>people</td><td>Person field (contains a person ID which is stored on the same account)</td><tr><td>phone</td><td>Phone field (up to 255 numbers and/or characters)</td><tr><td>time</td><td>Time field (format HH:MM:SS)</td><tr><td>timerange</td><td>Time-range field (has a start time and end time value, both HH:MM:SS)</td><tr><td>daterange</td><td>Date-range field (has a start date and end date value, both YYYY-MM-DD)</td><tr><td>address</td><td>Address field</dd></table> |
important_fields | object | No | — | Configuration for highlighting the field at specific stages. |
options | object[] | No | — | Field options (required for enum and set field types) |
required_fields | object | No | — | Required fields configuration for marking the field as mandatory when interacted with in the Pipedrive web UI. |
ui_visibility | object | No | — | UI visibility settings for the field. Controls where the field appears in the Pipedrive web UI. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"field_name": {
"type": "string",
"description": "Field name"
},
"field_type": {
"type": "string",
"description": "The type of the field<table><tr><th>Value</th><th>Description</th></tr><tr><td>`varchar`</td><td>Text (up to 255 characters)</td><tr><td>`varchar_auto`</td><td>Autocomplete text (up to 255 characters)</td><tr><td>`text`</td><td>Long text (up to 65k characters)</td><tr><td>`double`</td><td>Numeric value</td><tr><td>`monetary`</td><td>Monetary field (has a numeric value and a currency value)</td><tr><td>`date`</td><td>Date (format YYYY-MM-DD)</td><tr><td>`set`</td><td>Options field with a possibility of having multiple chosen options</td><tr><td>`enum`</td><td>Options field with a single possible chosen option</td><tr><td>`user`</td><td>User field (contains a user ID of another Pipedrive user)</td><tr><td>`org`</td><td>Organization field (contains an organization ID which is stored on the same account)</td><tr><td>`people`</td><td>Person field (contains a person ID which is stored on the same account)</td><tr><td>`phone`</td><td>Phone field (up to 255 numbers and/or characters)</td><tr><td>`time`</td><td>Time field (format HH:MM:SS)</td><tr><td>`timerange`</td><td>Time-range field (has a start time and end time value, both HH:MM:SS)</td><tr><td>`daterange`</td><td>Date-range field (has a start date and end date value, both YYYY-MM-DD)</td><tr><td>`address`</td><td>Address field</dd></table>",
"enum": [
"varchar",
"text",
"double",
"phone",
"date",
"daterange",
"time",
"timerange",
"set",
"enum",
"varchar_auto",
"address",
"monetary",
"org",
"people",
"user"
]
},
"important_fields": {
"type": "object",
"description": "Configuration for highlighting the field at specific stages.",
"properties": {
"enabled": {
"type": "boolean",
"description": "Whether the field is marked as important. When false, the field is not highlighted. When true with empty stage_ids, the field is important everywhere. When true with specific stage_ids, the field is important only at those deal stages. Default is false."
},
"stage_ids": {
"type": "array",
"items": {
"type": "integer"
},
"description": "Array of deal stage IDs where this person field should be highlighted as important. Must reference valid, active deal stages. Empty array when enabled is false."
}
}
},
"options": {
"type": "array",
"items": {
"type": "object",
"properties": {
"label": {
"type": "string",
"description": "The option label"
}
},
"required": [
"label"
]
},
"description": "Field options (required for enum and set field types)"
},
"required_fields": {
"type": "object",
"description": "Required fields configuration for marking the field as mandatory when interacted with in the Pipedrive web UI.",
"properties": {
"enabled": {
"type": "boolean",
"description": "Whether the field is required. When false, the field is optional. When true, the field is required when creating or updating persons. Default is false."
}
}
},
"ui_visibility": {
"type": "object",
"description": "UI visibility settings for the field. Controls where the field appears in the Pipedrive web UI.",
"properties": {
"add_visible_flag": {
"type": "boolean",
"description": "Whether the field is shown in the add person modal. Default is false. Cannot be set to false for required system fields ('name', 'org_id')."
},
"details_visible_flag": {
"type": "boolean",
"description": "Whether the field is shown in the person details view. Default is true."
},
"show_in_add_deal_dialog": {
"type": "object",
"description": "Configuration for showing this person field when adding a new deal. Only available for custom fields or specific eligible system fields. Default is show=false, order=null."
}
}
}
},
"required": [
"PCID",
"field_name",
"field_type"
]
}
pipedrive_contacts_add_person_field_options
Add person field options in bulk Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
field_code | string | Yes | — | The unique code identifying the field |
body | object[] | Yes | — | Array of options to add. Each item must contain a label. At least one option is required. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"field_code": {
"type": "string",
"description": "The unique code identifying the field"
},
"body": {
"type": "array",
"items": {
"type": "object",
"properties": {
"label": {
"type": "string",
"description": "The display label for the new option"
}
},
"required": [
"label"
]
},
"description": "Array of options to add. Each item must contain a label. At least one option is required."
}
},
"required": [
"PCID",
"field_code",
"body"
]
}
pipedrive_contacts_add_person_follower
Add a follower to a person Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The ID of the person |
user_id | integer | Yes | — | The ID of the user to add as a follower |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The ID of the person"
},
"user_id": {
"type": "integer",
"description": "The ID of the user to add as a follower"
}
},
"required": [
"PCID",
"id",
"user_id"
]
}
pipedrive_contacts_delete_organization
Delete a organization Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The ID of the organization |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The ID of the organization"
}
},
"required": [
"PCID",
"id"
]
}
pipedrive_contacts_delete_organization_field
Delete one organization field Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
field_code | string | Yes | — | The unique code identifying the field |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"field_code": {
"type": "string",
"description": "The unique code identifying the field"
}
},
"required": [
"PCID",
"field_code"
]
}
pipedrive_contacts_delete_organization_field_options
Delete organization field options in bulk Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
field_code | string | Yes | — | The unique code identifying the field |
body | object[] | Yes | — | Array of option IDs to delete. Each item must contain an ID of the option to delete. At least one option ID is required. The entire request fails if any option does not exist. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"field_code": {
"type": "string",
"description": "The unique code identifying the field"
},
"body": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The unique identifier of the option to delete"
}
},
"required": [
"id"
]
},
"description": "Array of option IDs to delete. Each item must contain an ID of the option to delete. At least one option ID is required. The entire request fails if any option does not exist."
}
},
"required": [
"PCID",
"field_code",
"body"
]
}
pipedrive_contacts_delete_organization_follower
Delete a follower from an organization Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The ID of the organization |
follower_id | integer | Yes | — | The ID of the following user |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The ID of the organization"
},
"follower_id": {
"type": "integer",
"description": "The ID of the following user"
}
},
"required": [
"PCID",
"id",
"follower_id"
]
}
pipedrive_contacts_delete_person
Delete a person Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The ID of the person |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The ID of the person"
}
},
"required": [
"PCID",
"id"
]
}
pipedrive_contacts_delete_person_field
Delete one person field Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
field_code | string | Yes | — | The unique code identifying the field |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"field_code": {
"type": "string",
"description": "The unique code identifying the field"
}
},
"required": [
"PCID",
"field_code"
]
}
pipedrive_contacts_delete_person_field_options
Delete person field options in bulk Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
field_code | string | Yes | — | The unique code identifying the field |
body | object[] | Yes | — | Array of option IDs to delete. Each item must contain an ID of the option to delete. At least one option ID is required. The entire request fails if any option does not exist. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"field_code": {
"type": "string",
"description": "The unique code identifying the field"
},
"body": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The unique identifier of the option to delete"
}
},
"required": [
"id"
]
},
"description": "Array of option IDs to delete. Each item must contain an ID of the option to delete. At least one option ID is required. The entire request fails if any option does not exist."
}
},
"required": [
"PCID",
"field_code",
"body"
]
}
pipedrive_contacts_delete_person_follower
Delete a follower from a person Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The ID of the person |
follower_id | integer | Yes | — | The ID of the following user |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The ID of the person"
},
"follower_id": {
"type": "integer",
"description": "The ID of the following user"
}
},
"required": [
"PCID",
"id",
"follower_id"
]
}
pipedrive_contacts_get_organization
Get details of a organization Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The ID of the organization |
include_fields | string | No | — | Optional comma separated string array of additional fields to include Valid values: next_activity_id, last_activity_id, open_deals_count, related_open_deals_count, closed_deals_count, related_closed_deals_count, email_messages_count, people_count, activities_count, done_activities_count, undone_activities_count, files_count, notes_count, followers_count, won_deals_count, related_won_deals_count, lost_deals_count, related_lost_deals_count, smart_bcc_email |
custom_fields | string | No | — | Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The ID of the organization"
},
"include_fields": {
"type": "string",
"description": "Optional comma separated string array of additional fields to include Valid values: next_activity_id, last_activity_id, open_deals_count, related_open_deals_count, closed_deals_count, related_closed_deals_count, email_messages_count, people_count, activities_count, done_activities_count, undone_activities_count, files_count, notes_count, followers_count, won_deals_count, related_won_deals_count, lost_deals_count, related_lost_deals_count, smart_bcc_email"
},
"custom_fields": {
"type": "string",
"description": "Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed."
}
},
"required": [
"PCID",
"id"
]
}
pipedrive_contacts_get_organization_field
Get one organization field Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
field_code | string | Yes | — | The unique code identifying the field |
include_fields | string | No | — | Optional comma separated string array of additional data namespaces to include in response Valid values: ui_visibility, important_fields, required_fields, ui_visibility,important_fields, ui_visibility,required_fields, important_fields,required_fields, ui_visibility,important_fields,required_fields |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"field_code": {
"type": "string",
"description": "The unique code identifying the field"
},
"include_fields": {
"type": "string",
"description": "Optional comma separated string array of additional data namespaces to include in response Valid values: ui_visibility, important_fields, required_fields, ui_visibility,important_fields, ui_visibility,required_fields, important_fields,required_fields, ui_visibility,important_fields,required_fields"
}
},
"required": [
"PCID",
"field_code"
]
}
pipedrive_contacts_get_organization_fields
Get all organization fields Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
include_fields | string | No | — | Optional comma separated string array of additional data namespaces to include in response Valid values: ui_visibility, important_fields, required_fields, ui_visibility,important_fields, ui_visibility,required_fields, important_fields,required_fields, ui_visibility,important_fields,required_fields |
limit | integer | No | — | For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed. |
cursor | string | No | — | For pagination, the marker (an opaque string value) representing the first item on the next page |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"include_fields": {
"type": "string",
"description": "Optional comma separated string array of additional data namespaces to include in response Valid values: ui_visibility, important_fields, required_fields, ui_visibility,important_fields, ui_visibility,required_fields, important_fields,required_fields, ui_visibility,important_fields,required_fields"
},
"limit": {
"type": "integer",
"description": "For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed."
},
"cursor": {
"type": "string",
"description": "For pagination, the marker (an opaque string value) representing the first item on the next page"
}
},
"required": [
"PCID"
]
}
pipedrive_contacts_get_organization_followers
List followers of an organization Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The ID of the organization |
limit | integer | No | — | For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed. |
cursor | string | No | — | For pagination, the marker (an opaque string value) representing the first item on the next page |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The ID of the organization"
},
"limit": {
"type": "integer",
"description": "For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed."
},
"cursor": {
"type": "string",
"description": "For pagination, the marker (an opaque string value) representing the first item on the next page"
}
},
"required": [
"PCID",
"id"
]
}
pipedrive_contacts_get_organization_followers_changelog
List followers changelog of an organization Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The ID of the organization |
limit | integer | No | — | For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed. |
cursor | string | No | — | For pagination, the marker (an opaque string value) representing the first item on the next page |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The ID of the organization"
},
"limit": {
"type": "integer",
"description": "For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed."
},
"cursor": {
"type": "string",
"description": "For pagination, the marker (an opaque string value) representing the first item on the next page"
}
},
"required": [
"PCID",
"id"
]
}
pipedrive_contacts_get_organizations
Get all organizations Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
filter_id | integer | No | — | If supplied, only organizations matching the specified filter are returned |
ids | string | No | — | Optional comma separated string array of up to 100 entity ids to fetch. If filter_id is provided, this is ignored. If any of the requested entities do not exist or are not visible, they are not included in the response. |
owner_id | integer | No | — | If supplied, only organizations owned by the specified user are returned. If filter_id is provided, this is ignored. |
updated_since | string | No | — | If set, only organizations with an update_time later than or equal to this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z. |
updated_until | string | No | — | If set, only organizations with an update_time earlier than this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z. |
sort_by | string | No | — | The field to sort by. Supported fields: id, update_time, add_time. |
sort_direction | string | No | — | The sorting direction. Supported values: asc, desc. |
include_fields | string | No | — | Optional comma separated string array of additional fields to include Valid values: next_activity_id, last_activity_id, open_deals_count, related_open_deals_count, closed_deals_count, related_closed_deals_count, email_messages_count, people_count, activities_count, done_activities_count, undone_activities_count, files_count, notes_count, followers_count, won_deals_count, related_won_deals_count, lost_deals_count, related_lost_deals_count, smart_bcc_email |
custom_fields | string | No | — | Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed. |
limit | integer | No | — | For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed. |
cursor | string | No | — | For pagination, the marker (an opaque string value) representing the first item on the next page |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"filter_id": {
"type": "integer",
"description": "If supplied, only organizations matching the specified filter are returned"
},
"ids": {
"type": "string",
"description": "Optional comma separated string array of up to 100 entity ids to fetch. If filter_id is provided, this is ignored. If any of the requested entities do not exist or are not visible, they are not included in the response."
},
"owner_id": {
"type": "integer",
"description": "If supplied, only organizations owned by the specified user are returned. If filter_id is provided, this is ignored."
},
"updated_since": {
"type": "string",
"description": "If set, only organizations with an `update_time` later than or equal to this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z."
},
"updated_until": {
"type": "string",
"description": "If set, only organizations with an `update_time` earlier than this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z."
},
"sort_by": {
"type": "string",
"description": "The field to sort by. Supported fields: `id`, `update_time`, `add_time`.",
"enum": [
"id",
"update_time",
"add_time"
]
},
"sort_direction": {
"type": "string",
"description": "The sorting direction. Supported values: `asc`, `desc`.",
"enum": [
"asc",
"desc"
]
},
"include_fields": {
"type": "string",
"description": "Optional comma separated string array of additional fields to include Valid values: next_activity_id, last_activity_id, open_deals_count, related_open_deals_count, closed_deals_count, related_closed_deals_count, email_messages_count, people_count, activities_count, done_activities_count, undone_activities_count, files_count, notes_count, followers_count, won_deals_count, related_won_deals_count, lost_deals_count, related_lost_deals_count, smart_bcc_email"
},
"custom_fields": {
"type": "string",
"description": "Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed."
},
"limit": {
"type": "integer",
"description": "For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed."
},
"cursor": {
"type": "string",
"description": "For pagination, the marker (an opaque string value) representing the first item on the next page"
}
},
"required": [
"PCID"
]
}
pipedrive_contacts_get_person
Get details of a person Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The ID of the person |
include_fields | string | No | — | Optional comma separated string array of additional fields to include. marketing_status and doi_status can only be included if the company has marketing app enabled. Valid values: next_activity_id, last_activity_id, open_deals_count, related_open_deals_count, closed_deals_count, related_closed_deals_count, participant_open_deals_count, participant_closed_deals_count, email_messages_count, activities_count, done_activities_count, undone_activities_count, files_count, notes_count, followers_count, won_deals_count, related_won_deals_count, lost_deals_count, related_lost_deals_count, last_incoming_mail_time, last_outgoing_mail_time, marketing_status, doi_status, smart_bcc_email |
custom_fields | string | No | — | Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The ID of the person"
},
"include_fields": {
"type": "string",
"description": "Optional comma separated string array of additional fields to include. `marketing_status` and `doi_status` can only be included if the company has marketing app enabled. Valid values: next_activity_id, last_activity_id, open_deals_count, related_open_deals_count, closed_deals_count, related_closed_deals_count, participant_open_deals_count, participant_closed_deals_count, email_messages_count, activities_count, done_activities_count, undone_activities_count, files_count, notes_count, followers_count, won_deals_count, related_won_deals_count, lost_deals_count, related_lost_deals_count, last_incoming_mail_time, last_outgoing_mail_time, marketing_status, doi_status, smart_bcc_email"
},
"custom_fields": {
"type": "string",
"description": "Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed."
}
},
"required": [
"PCID",
"id"
]
}
pipedrive_contacts_get_person_field
Get one person field Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
field_code | string | Yes | — | The unique code identifying the field |
include_fields | string | No | — | Optional comma separated string array of additional data namespaces to include in response Valid values: ui_visibility, important_fields, required_fields, ui_visibility,important_fields, ui_visibility,required_fields, important_fields,required_fields, ui_visibility,important_fields,required_fields |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"field_code": {
"type": "string",
"description": "The unique code identifying the field"
},
"include_fields": {
"type": "string",
"description": "Optional comma separated string array of additional data namespaces to include in response Valid values: ui_visibility, important_fields, required_fields, ui_visibility,important_fields, ui_visibility,required_fields, important_fields,required_fields, ui_visibility,important_fields,required_fields"
}
},
"required": [
"PCID",
"field_code"
]
}
pipedrive_contacts_get_person_fields
Get all person fields Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
include_fields | string | No | — | Optional comma separated string array of additional data namespaces to include in response Valid values: ui_visibility, important_fields, required_fields, ui_visibility,important_fields, ui_visibility,required_fields, important_fields,required_fields, ui_visibility,important_fields,required_fields |
limit | integer | No | — | For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed. |
cursor | string | No | — | For pagination, the marker (an opaque string value) representing the first item on the next page |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"include_fields": {
"type": "string",
"description": "Optional comma separated string array of additional data namespaces to include in response Valid values: ui_visibility, important_fields, required_fields, ui_visibility,important_fields, ui_visibility,required_fields, important_fields,required_fields, ui_visibility,important_fields,required_fields"
},
"limit": {
"type": "integer",
"description": "For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed."
},
"cursor": {
"type": "string",
"description": "For pagination, the marker (an opaque string value) representing the first item on the next page"
}
},
"required": [
"PCID"
]
}
pipedrive_contacts_get_person_followers
List followers of a person Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The ID of the person |
limit | integer | No | — | For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed. |
cursor | string | No | — | For pagination, the marker (an opaque string value) representing the first item on the next page |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The ID of the person"
},
"limit": {
"type": "integer",
"description": "For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed."
},
"cursor": {
"type": "string",
"description": "For pagination, the marker (an opaque string value) representing the first item on the next page"
}
},
"required": [
"PCID",
"id"
]
}
pipedrive_contacts_get_person_followers_changelog
List followers changelog of a person Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The ID of the person |
limit | integer | No | — | For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed. |
cursor | string | No | — | For pagination, the marker (an opaque string value) representing the first item on the next page |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The ID of the person"
},
"limit": {
"type": "integer",
"description": "For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed."
},
"cursor": {
"type": "string",
"description": "For pagination, the marker (an opaque string value) representing the first item on the next page"
}
},
"required": [
"PCID",
"id"
]
}
pipedrive_contacts_get_person_picture
Get picture of a person Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The ID of the person |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The ID of the person"
}
},
"required": [
"PCID",
"id"
]
}
pipedrive_contacts_get_persons
Get all persons Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
filter_id | integer | No | — | If supplied, only persons matching the specified filter are returned |
ids | string | No | — | Optional comma separated string array of up to 100 entity ids to fetch. If filter_id is provided, this is ignored. If any of the requested entities do not exist or are not visible, they are not included in the response. |
owner_id | integer | No | — | If supplied, only persons owned by the specified user are returned. If filter_id is provided, this is ignored. |
org_id | integer | No | — | If supplied, only persons linked to the specified organization are returned. If filter_id is provided, this is ignored. |
deal_id | integer | No | — | If supplied, only persons linked to the specified deal are returned. If filter_id is provided, this is ignored. |
updated_since | string | No | — | If set, only persons with an update_time later than or equal to this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z. |
updated_until | string | No | — | If set, only persons with an update_time earlier than this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z. |
sort_by | string | No | — | The field to sort by. Supported fields: id, update_time, add_time. |
sort_direction | string | No | — | The sorting direction. Supported values: asc, desc. |
include_fields | string | No | — | Optional comma separated string array of additional fields to include. marketing_status and doi_status can only be included if the company has marketing app enabled. Valid values: next_activity_id, last_activity_id, open_deals_count, related_open_deals_count, closed_deals_count, related_closed_deals_count, participant_open_deals_count, participant_closed_deals_count, email_messages_count, activities_count, done_activities_count, undone_activities_count, files_count, notes_count, followers_count, won_deals_count, related_won_deals_count, lost_deals_count, related_lost_deals_count, last_incoming_mail_time, last_outgoing_mail_time, marketing_status, doi_status, smart_bcc_email |
custom_fields | string | No | — | Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed. |
limit | integer | No | — | For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed. |
cursor | string | No | — | For pagination, the marker (an opaque string value) representing the first item on the next page |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"filter_id": {
"type": "integer",
"description": "If supplied, only persons matching the specified filter are returned"
},
"ids": {
"type": "string",
"description": "Optional comma separated string array of up to 100 entity ids to fetch. If filter_id is provided, this is ignored. If any of the requested entities do not exist or are not visible, they are not included in the response."
},
"owner_id": {
"type": "integer",
"description": "If supplied, only persons owned by the specified user are returned. If filter_id is provided, this is ignored."
},
"org_id": {
"type": "integer",
"description": "If supplied, only persons linked to the specified organization are returned. If filter_id is provided, this is ignored."
},
"deal_id": {
"type": "integer",
"description": "If supplied, only persons linked to the specified deal are returned. If filter_id is provided, this is ignored."
},
"updated_since": {
"type": "string",
"description": "If set, only persons with an `update_time` later than or equal to this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z."
},
"updated_until": {
"type": "string",
"description": "If set, only persons with an `update_time` earlier than this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z."
},
"sort_by": {
"type": "string",
"description": "The field to sort by. Supported fields: `id`, `update_time`, `add_time`.",
"enum": [
"id",
"update_time",
"add_time"
]
},
"sort_direction": {
"type": "string",
"description": "The sorting direction. Supported values: `asc`, `desc`.",
"enum": [
"asc",
"desc"
]
},
"include_fields": {
"type": "string",
"description": "Optional comma separated string array of additional fields to include. `marketing_status` and `doi_status` can only be included if the company has marketing app enabled. Valid values: next_activity_id, last_activity_id, open_deals_count, related_open_deals_count, closed_deals_count, related_closed_deals_count, participant_open_deals_count, participant_closed_deals_count, email_messages_count, activities_count, done_activities_count, undone_activities_count, files_count, notes_count, followers_count, won_deals_count, related_won_deals_count, lost_deals_count, related_lost_deals_count, last_incoming_mail_time, last_outgoing_mail_time, marketing_status, doi_status, smart_bcc_email"
},
"custom_fields": {
"type": "string",
"description": "Optional comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for faster results and smaller response.<br/>A maximum of 15 keys is allowed."
},
"limit": {
"type": "integer",
"description": "For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed."
},
"cursor": {
"type": "string",
"description": "For pagination, the marker (an opaque string value) representing the first item on the next page"
}
},
"required": [
"PCID"
]
}
pipedrive_contacts_search_organization
Search organizations Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
term | string | Yes | — | The search term to look for. Minimum 2 characters (or 1 if using exact_match). Please note that the search term has to be URL encoded. |
fields | string | No | — | A comma-separated string array. The fields to perform the search from. Defaults to all of them. Only the following custom field types are searchable: address, varchar, text, varchar_auto, double, monetary and phone. Read more about searching by custom fields <a href=“https://support.pipedrive.com/en/article/search-finding-what-you-need#searching-by-custom-fields” target=“_blank” rel=“noopener noreferrer”>here</a>. |
exact_match | boolean | No | — | When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive. |
limit | integer | No | — | For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed. |
cursor | string | No | — | For pagination, the marker (an opaque string value) representing the first item on the next page |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"term": {
"type": "string",
"description": "The search term to look for. Minimum 2 characters (or 1 if using `exact_match`). Please note that the search term has to be URL encoded."
},
"fields": {
"type": "string",
"description": "A comma-separated string array. The fields to perform the search from. Defaults to all of them. Only the following custom field types are searchable: `address`, `varchar`, `text`, `varchar_auto`, `double`, `monetary` and `phone`. Read more about searching by custom fields <a href=\"https://support.pipedrive.com/en/article/search-finding-what-you-need#searching-by-custom-fields\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>."
},
"exact_match": {
"type": "boolean",
"description": "When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive."
},
"limit": {
"type": "integer",
"description": "For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed."
},
"cursor": {
"type": "string",
"description": "For pagination, the marker (an opaque string value) representing the first item on the next page"
}
},
"required": [
"PCID",
"term"
]
}
pipedrive_contacts_search_persons
Search persons Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
term | string | Yes | — | The search term to look for. Minimum 2 characters (or 1 if using exact_match). Please note that the search term has to be URL encoded. |
fields | string | No | — | A comma-separated string array. The fields to perform the search from. Defaults to all of them. Only the following custom field types are searchable: address, varchar, text, varchar_auto, double, monetary and phone. Read more about searching by custom fields <a href=“https://support.pipedrive.com/en/article/search-finding-what-you-need#searching-by-custom-fields” target=“_blank” rel=“noopener noreferrer”>here</a>. Valid values: custom_fields, email, notes, phone, name |
exact_match | boolean | No | — | When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive. |
organization_id | integer | No | — | Will filter persons by the provided organization ID. The upper limit of found persons associated with the organization is 2000. |
include_fields | string | No | — | Supports including optional fields in the results which are not provided by default Valid values: person.picture |
limit | integer | No | — | For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed. |
cursor | string | No | — | For pagination, the marker (an opaque string value) representing the first item on the next page |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"term": {
"type": "string",
"description": "The search term to look for. Minimum 2 characters (or 1 if using `exact_match`). Please note that the search term has to be URL encoded."
},
"fields": {
"type": "string",
"description": "A comma-separated string array. The fields to perform the search from. Defaults to all of them. Only the following custom field types are searchable: `address`, `varchar`, `text`, `varchar_auto`, `double`, `monetary` and `phone`. Read more about searching by custom fields <a href=\"https://support.pipedrive.com/en/article/search-finding-what-you-need#searching-by-custom-fields\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>. Valid values: custom_fields, email, notes, phone, name"
},
"exact_match": {
"type": "boolean",
"description": "When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive."
},
"organization_id": {
"type": "integer",
"description": "Will filter persons by the provided organization ID. The upper limit of found persons associated with the organization is 2000."
},
"include_fields": {
"type": "string",
"description": "Supports including optional fields in the results which are not provided by default Valid values: person.picture"
},
"limit": {
"type": "integer",
"description": "For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed."
},
"cursor": {
"type": "string",
"description": "For pagination, the marker (an opaque string value) representing the first item on the next page"
}
},
"required": [
"PCID",
"term"
]
}
pipedrive_contacts_update_organization
Update a organization Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The ID of the organization |
add_time | string | No | — | The creation date and time of the organization |
address | object | No | — | The address of the organization |
custom_fields | object | No | — | An object where each key represents a custom field. All custom fields are referenced as randomly generated 40-character hashes |
label_ids | integer[] | No | — | The IDs of labels assigned to the organization |
name | string | No | — | The name of the organization |
owner_id | integer | No | — | The ID of the user who owns the organization |
update_time | string | No | — | The last updated date and time of the organization |
visible_to | integer | No | — | The visibility of the organization |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The ID of the organization"
},
"add_time": {
"type": "string",
"description": "The creation date and time of the organization"
},
"address": {
"type": "object",
"description": "The address of the organization",
"properties": {
"value": {
"type": "string",
"description": "The full address of the organization"
},
"country": {
"type": "string",
"description": "Country of the organization"
},
"admin_area_level_1": {
"type": "string",
"description": "Admin area level 1 (e.g. state) of the organization"
},
"admin_area_level_2": {
"type": "string",
"description": "Admin area level 2 (e.g. county) of the organization"
},
"locality": {
"type": "string",
"description": "Locality (e.g. city) of the organization"
},
"sublocality": {
"type": "string",
"description": "Sublocality (e.g. neighborhood) of the organization"
},
"route": {
"type": "string",
"description": "Route (e.g. street) of the organization"
},
"street_number": {
"type": "string",
"description": "Street number of the organization"
},
"subpremise": {
"type": "string",
"description": "Subpremise (e.g. apartment/suite number) of the organization"
},
"postal_code": {
"type": "string",
"description": "Postal code of the organization"
}
}
},
"custom_fields": {
"type": "object",
"description": "An object where each key represents a custom field. All custom fields are referenced as randomly generated 40-character hashes"
},
"label_ids": {
"type": "array",
"items": {
"type": "integer"
},
"description": "The IDs of labels assigned to the organization"
},
"name": {
"type": "string",
"description": "The name of the organization"
},
"owner_id": {
"type": "integer",
"description": "The ID of the user who owns the organization"
},
"update_time": {
"type": "string",
"description": "The last updated date and time of the organization"
},
"visible_to": {
"type": "integer",
"description": "The visibility of the organization"
}
},
"required": [
"PCID",
"id"
]
}
pipedrive_contacts_update_organization_field
Update one organization field Parameters:| Parameter | Type | Required | Default | Description | |
|---|---|---|---|---|---|
field_code | string | Yes | — | The unique code identifying the field | |
description | string | null | No | — | Field description |
field_name | string | No | — | Field name | |
important_fields | object | No | — | Configuration for highlighting the field at specific stages. | |
required_fields | object | No | — | Required fields configuration for marking the field as mandatory when interacted with in the Pipedrive web UI. | |
ui_visibility | object | No | — | UI visibility settings for the field. Controls where the field appears in the Pipedrive web UI. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"field_code": {
"type": "string",
"description": "The unique code identifying the field"
},
"description": {
"type": [
"string",
"null"
],
"description": "Field description"
},
"field_name": {
"type": "string",
"description": "Field name"
},
"important_fields": {
"type": "object",
"description": "Configuration for highlighting the field at specific stages.",
"properties": {
"enabled": {
"type": "boolean",
"description": "Whether the field is marked as important. When false, the field is not highlighted. When true with empty stage_ids, the field is important everywhere. When true with specific stage_ids, the field is important only at those deal stages. Default is false."
},
"stage_ids": {
"type": "array",
"items": {
"type": "integer"
},
"description": "Array of deal stage IDs where this organization field should be highlighted as important. Must reference valid, active deal stages. Empty array when enabled is false."
}
}
},
"required_fields": {
"type": "object",
"description": "Required fields configuration for marking the field as mandatory when interacted with in the Pipedrive web UI.",
"properties": {
"enabled": {
"type": "boolean",
"description": "Whether the field is required. When false, the field is optional. When true, the field is required when creating or updating organizations. Default is false."
}
}
},
"ui_visibility": {
"type": "object",
"description": "UI visibility settings for the field. Controls where the field appears in the Pipedrive web UI.",
"properties": {
"add_visible_flag": {
"type": "boolean",
"description": "Whether the field is shown in the add organization modal. Default is false. Cannot be set to false for the 'name' system field."
},
"details_visible_flag": {
"type": "boolean",
"description": "Whether the field is shown in the organization details view. Default is true."
},
"show_in_add_deal_dialog": {
"type": "object",
"description": "Configuration for showing this organization field when adding a new deal. Only available for custom fields or specific eligible system fields. Default is show=false, order=null."
},
"show_in_add_person_dialog": {
"type": "object",
"description": "Configuration for showing this organization field when adding a new person. Only available for custom fields or specific eligible system fields. Default is show=false, order=null."
}
}
}
},
"required": [
"PCID",
"field_code"
]
}
pipedrive_contacts_update_organization_field_options
Update organization field options in bulk Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
field_code | string | Yes | — | The unique code identifying the field |
body | object[] | Yes | — | Array of options to update. Each item must contain an ID and the updated label. At least one option is required. The entire request fails if any option does not exist. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"field_code": {
"type": "string",
"description": "The unique code identifying the field"
},
"body": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The unique identifier of the option to update"
},
"label": {
"type": "string",
"description": "The new display label for the option"
}
},
"required": [
"id",
"label"
]
},
"description": "Array of options to update. Each item must contain an ID and the updated label. At least one option is required. The entire request fails if any option does not exist."
}
},
"required": [
"PCID",
"field_code",
"body"
]
}
pipedrive_contacts_update_person
Update a person Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The ID of the person |
add_time | string | No | — | The creation date and time of the person |
custom_fields | object | No | — | An object where each key represents a custom field. All custom fields are referenced as randomly generated 40-character hashes |
emails | object[] | No | — | The emails of the person |
label_ids | integer[] | No | — | The IDs of labels assigned to the person |
marketing_status | string | No | — | If the person does not have a valid email address, then the marketing status is not set and no_consent is returned for the marketing_status value when the new person is created. If the change is forbidden, the status will remain unchanged for every call that tries to modify the marketing status. Please be aware that it is only allowed once to change the marketing status from an old status to a new one.<table><tr><th>Value</th><th>Description</th></tr><tr><td>no_consent</td><td>The customer has not given consent to receive any marketing communications</td></tr><tr><td>unsubscribed</td><td>The customers have unsubscribed from ALL marketing communications</td></tr><tr><td>subscribed</td><td>The customers are subscribed and are counted towards marketing caps</td></tr><tr><td>archived</td><td>The customers with subscribed status can be moved to archived to save consent, but they are not paid for</td></tr></table> |
name | string | No | — | The name of the person |
org_id | integer | No | — | The ID of the organization linked to the person |
owner_id | integer | No | — | The ID of the user who owns the person |
phones | object[] | No | — | The phones of the person |
update_time | string | No | — | The last updated date and time of the person |
visible_to | integer | No | — | The visibility of the person |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The ID of the person"
},
"add_time": {
"type": "string",
"description": "The creation date and time of the person"
},
"custom_fields": {
"type": "object",
"description": "An object where each key represents a custom field. All custom fields are referenced as randomly generated 40-character hashes"
},
"emails": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "The email address of the person"
},
"primary": {
"type": "boolean",
"description": "Whether the email is primary or not"
},
"label": {
"type": "string",
"description": "The email address classification label"
}
}
},
"description": "The emails of the person"
},
"label_ids": {
"type": "array",
"items": {
"type": "integer"
},
"description": "The IDs of labels assigned to the person"
},
"marketing_status": {
"type": "string",
"description": "If the person does not have a valid email address, then the marketing status is **not set** and `no_consent` is returned for the `marketing_status` value when the new person is created. If the change is forbidden, the status will remain unchanged for every call that tries to modify the marketing status. Please be aware that it is only allowed **once** to change the marketing status from an old status to a new one.<table><tr><th>Value</th><th>Description</th></tr><tr><td>`no_consent`</td><td>The customer has not given consent to receive any marketing communications</td></tr><tr><td>`unsubscribed`</td><td>The customers have unsubscribed from ALL marketing communications</td></tr><tr><td>`subscribed`</td><td>The customers are subscribed and are counted towards marketing caps</td></tr><tr><td>`archived`</td><td>The customers with `subscribed` status can be moved to `archived` to save consent, but they are not paid for</td></tr></table>",
"enum": [
"no_consent",
"unsubscribed",
"subscribed",
"archived"
]
},
"name": {
"type": "string",
"description": "The name of the person"
},
"org_id": {
"type": "integer",
"description": "The ID of the organization linked to the person"
},
"owner_id": {
"type": "integer",
"description": "The ID of the user who owns the person"
},
"phones": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "The phone number of the person"
},
"primary": {
"type": "boolean",
"description": "Whether the phone number is primary or not"
},
"label": {
"type": "string",
"description": "The phone number classification label"
}
}
},
"description": "The phones of the person"
},
"update_time": {
"type": "string",
"description": "The last updated date and time of the person"
},
"visible_to": {
"type": "integer",
"description": "The visibility of the person"
}
},
"required": [
"PCID",
"id"
]
}
pipedrive_contacts_update_person_field
Update one person field Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
field_code | string | Yes | — | The unique code identifying the field |
field_name | string | No | — | Field name |
important_fields | object | No | — | Configuration for highlighting the field at specific stages. |
required_fields | object | No | — | Required fields configuration for marking the field as mandatory when interacted with in the Pipedrive web UI. |
ui_visibility | object | No | — | UI visibility settings for the field. Controls where the field appears in the Pipedrive web UI. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"field_code": {
"type": "string",
"description": "The unique code identifying the field"
},
"field_name": {
"type": "string",
"description": "Field name"
},
"important_fields": {
"type": "object",
"description": "Configuration for highlighting the field at specific stages.",
"properties": {
"enabled": {
"type": "boolean",
"description": "Whether the field is marked as important. When false, the field is not highlighted. When true with empty stage_ids, the field is important everywhere. When true with specific stage_ids, the field is important only at those deal stages. Default is false."
},
"stage_ids": {
"type": "array",
"items": {
"type": "integer"
},
"description": "Array of deal stage IDs where this person field should be highlighted as important. Must reference valid, active deal stages. Empty array when enabled is false."
}
}
},
"required_fields": {
"type": "object",
"description": "Required fields configuration for marking the field as mandatory when interacted with in the Pipedrive web UI.",
"properties": {
"enabled": {
"type": "boolean",
"description": "Whether the field is required. When false, the field is optional. When true, the field is required when creating or updating persons. Default is false."
}
}
},
"ui_visibility": {
"type": "object",
"description": "UI visibility settings for the field. Controls where the field appears in the Pipedrive web UI.",
"properties": {
"add_visible_flag": {
"type": "boolean",
"description": "Whether the field is shown in the add person modal. Default is false. Cannot be set to false for required system fields ('name', 'org_id')."
},
"details_visible_flag": {
"type": "boolean",
"description": "Whether the field is shown in the person details view. Default is true."
},
"show_in_add_deal_dialog": {
"type": "object",
"description": "Configuration for showing this person field when adding a new deal. Only available for custom fields or specific eligible system fields. Default is show=false, order=null."
}
}
}
},
"required": [
"PCID",
"field_code"
]
}
pipedrive_contacts_update_person_field_options
Update person field options in bulk Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
field_code | string | Yes | — | The unique code identifying the field |
body | object[] | Yes | — | Array of options to update. Each item must contain an ID and the updated label. At least one option is required. The entire request fails if any option does not exist. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"field_code": {
"type": "string",
"description": "The unique code identifying the field"
},
"body": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The unique identifier of the option to update"
},
"label": {
"type": "string",
"description": "The new display label for the option"
}
},
"required": [
"id",
"label"
]
},
"description": "Array of options to update. Each item must contain an ID and the updated label. At least one option is required. The entire request fails if any option does not exist."
}
},
"required": [
"PCID",
"field_code",
"body"
]
}