> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# Pipedrive: Add Person
> Add a new person. Pipedrive Add Person reference includes SDK V2 and CLI requests, input constraints, response fields, and Deepline cost.
Add a new person.
Tool ID: `pipedrive_add_person`
## Run this action
Use the TypeScript SDK for a single call. Put `ctx.tools.execute(...)` inside a Play when the call should be durable, scheduled, or run across a CSV.
```ts theme={null}
import { Deepline } from 'deepline';
const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
'pipedrive_add_person',
{
"name": "Example",
"owner_id": 123,
"org_id": 123
},
);
console.log(result.toolResponse.raw);
```
### CLI
```bash theme={null}
deepline tools execute pipedrive_add_person --input '{
"name": "Example",
"owner_id": 123,
"org_id": 123
}' --json
```
## Example response
The SDK exposes this shape at `result.toolResponse.raw`. Values below are representative.
```json theme={null}
{
"data": {
"success": true,
"data": {
"id": 123,
"name": "Example",
"first_name": "Jane"
}
}
}
```
Use `deepline tools get pipedrive_add_person --json` for the latest machine-readable contract.
## Input reference
Adds a new person. If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field. The `im`, `postal_address`, `notes`, `birthday` and `job_title` fields don’t exist by default in Pipedrive and are only created when you set up your contact sync.
| Name | Type | Required | Default | Details |
| -------------------------- | -------------------------------------------------------------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `payload.name` | `string` | No | — | The name of the person |
| `payload.owner_id` | `integer` | No | — | The ID of the user who owns the person |
| `payload.org_id` | `integer` | No | — | The ID of the organization linked to the person |
| `payload.add_time` | `string` | No | — | The creation date and time of the person |
| `payload.emails` | `array` | No | — | The emails of the person |
| `payload.phones` | `array` | No | — | The phones of the person |
| `payload.visible_to` | `integer` | No | — | The visibility of the person |
| `payload.label_ids` | `array` | No | — | The IDs of labels assigned to the person |
| `payload.postal_address` | `object` | No | — | Postal address of the person, included if contact sync is enabled for the company |
| `payload.notes` | `string` | No | — | Contact sync notes of the person, maximum 10 000 characters, included if contact sync is enabled for the company |
| `payload.im` | `array` | No | — | The instant messaging accounts of the person, included if contact sync is enabled for the company |
| `payload.birthday` | `string` | No | — | The birthday of the person, included if contact sync is enabled for the company |
| `payload.job_title` | `string` | No | — | The job title of the person, included if contact sync is enabled for the company |
| `payload.marketing_status` | `"no_consent" \| "unsubscribed" \| "subscribed" \| "archived"` | 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. Value Description `no_consent` The customer has not given consent to receive any See the live schema for the complete constraint. |
| `payload.custom_fields` | `object` | No | — | An object where each key represents a custom field. All custom fields are referenced as randomly generated 40-character hashes. To clear a custom field value, set it to `null`. For multi-option fields (field type `set`), use `null` to clear the selection — sending an empty array `[]` is not supported and will result in a validation error. |
Show raw input schema
### Input JSON Schema
```json theme={null}
{
"type": "object",
"description": "Adds a new person. If the company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also accept and return the `marketing_status` field. The `im`, `postal_address`, `notes`, `birthday` and `job_title` fields don’t exist by default in Pipedrive and are only created when you set up your contact sync.",
"properties": {
"name": {
"type": "string",
"description": "The name of the person"
},
"owner_id": {
"type": "integer",
"description": "The ID of the user who owns the person"
},
"org_id": {
"type": "integer",
"description": "The ID of the organization linked to the person"
},
"add_time": {
"type": "string",
"description": "The creation date and time of the person"
},
"emails": {
"type": "array",
"description": "The emails of the person",
"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"
}
},
"additionalProperties": false
}
},
"phones": {
"type": "array",
"description": "The phones of the person",
"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"
}
},
"additionalProperties": false
}
},
"visible_to": {
"type": "integer",
"description": "The visibility of the person"
},
"label_ids": {
"type": "array",
"description": "The IDs of labels assigned to the person",
"items": {
"type": "integer"
}
},
"postal_address": {
"type": "object",
"description": "Postal address of the person, included if contact sync is enabled for the company",
"properties": {
"value": {
"type": "string",
"description": "The full address of the person"
},
"country": {
"type": "string",
"description": "Country of the person"
},
"admin_area_level_1": {
"type": "string",
"description": "Admin area level 1 (e.g. state) of the person"
},
"admin_area_level_2": {
"type": "string",
"description": "Admin area level 2 (e.g. county) of the person"
},
"locality": {
"type": "string",
"description": "Locality (e.g. city) of the person"
},
"sublocality": {
"type": "string",
"description": "Sublocality (e.g. neighborhood) of the person"
},
"route": {
"type": "string",
"description": "Route (e.g. street) of the person"
},
"street_number": {
"type": "string",
"description": "Street number of the person"
},
"subpremise": {
"type": "string",
"description": "Subpremise (e.g. apartment/suite number) of the person"
},
"postal_code": {
"type": "string",
"description": "Postal code of the person"
}
},
"additionalProperties": false
},
"notes": {
"type": "string",
"description": "Contact sync notes of the person, maximum 10 000 characters, included if contact sync is enabled for the company"
},
"im": {
"type": "array",
"description": "The instant messaging accounts of the person, included if contact sync is enabled for the company",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "The instant messaging account of the person"
},
"primary": {
"type": "boolean",
"description": "Whether the instant messaging account is primary or not"
},
"label": {
"type": "string",
"description": "The instant messaging account classification label"
}
},
"additionalProperties": false
}
},
"birthday": {
"type": "string",
"description": "The birthday of the person, included if contact sync is enabled for the company"
},
"job_title": {
"type": "string",
"description": "The job title of the person, included if contact sync is enabled for the company"
},
"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. Value Description `no_consent` The customer has not given consent to receive any marketing communications `unsubscribed` The customers have unsubscribed from ALL marketing communications `subscribed` The customers are subscribed and are counted towards marketing caps `archived` The customers with `subscribed` status can be moved to `archived` to save consent, but they are not paid for",
"enum": [
"no_consent",
"unsubscribed",
"subscribed",
"archived"
]
},
"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. To clear a custom field value, set it to `null`. For multi-option fields (field type `set`), use `null` to clear the selection — sending an empty array `[]` is not supported and will result in a validation error.",
"additionalProperties": true
}
},
"required": [],
"additionalProperties": false
}
```
## Output reference
Standard tool result payload.
| Name | Type | Required | Default | Details |
| ---------------------------------------------------- | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `result.data` | `object` | Yes | — | Provider response payload. |
| `result.data.success` | `boolean` | No | — | If the response is successful or not |
| `result.data.data` | `object` | No | — | — |
| `result.data.data.id` | `integer` | No | — | The ID of the person |
| `result.data.data.name` | `string` | No | — | The name of the person |
| `result.data.data.first_name` | `string` | No | — | The first name of the person |
| `result.data.data.last_name` | `string` | No | — | The last name of the person |
| `result.data.data.owner_id` | `integer` | No | — | The ID of the user who owns the person |
| `result.data.data.org_id` | `integer` | No | — | The ID of the organization linked to the person |
| `result.data.data.add_time` | `string` | No | — | The creation date and time of the person |
| `result.data.data.update_time` | `string` | No | — | The last updated date and time of the person |
| `result.data.data.emails` | `array` | No | — | The emails of the person |
| `result.data.data.emails[].value` | `string` | No | — | The email address of the person |
| `result.data.data.emails[].primary` | `boolean` | No | — | Whether the email is primary or not |
| `result.data.data.emails[].label` | `string` | No | — | The email address classification label |
| `result.data.data.phones` | `array` | No | — | The phones of the person |
| `result.data.data.phones[].value` | `string` | No | — | The phone number of the person |
| `result.data.data.phones[].primary` | `boolean` | No | — | Whether the phone number is primary or not |
| `result.data.data.phones[].label` | `string` | No | — | The phone number classification label |
| `result.data.data.is_deleted` | `boolean` | No | — | Whether the person is deleted or not |
| `result.data.data.visible_to` | `integer` | No | — | The visibility of the person |
| `result.data.data.label_ids` | `array` | No | — | The IDs of labels assigned to the person |
| `result.data.data.picture_id` | `integer` | No | — | The ID of the picture associated with the person |
| `result.data.data.postal_address` | `object` | No | — | Postal address of the person, included if contact sync is enabled for the company |
| `result.data.data.postal_address.value` | `string` | No | — | The full address of the person |
| `result.data.data.postal_address.country` | `string` | No | — | Country of the person |
| `result.data.data.postal_address.admin_area_level_1` | `string` | No | — | Admin area level 1 (e.g. state) of the person |
| `result.data.data.postal_address.admin_area_level_2` | `string` | No | — | Admin area level 2 (e.g. county) of the person |
| `result.data.data.postal_address.locality` | `string` | No | — | Locality (e.g. city) of the person |
| `result.data.data.postal_address.sublocality` | `string` | No | — | Sublocality (e.g. neighborhood) of the person |
| `result.data.data.postal_address.route` | `string` | No | — | Route (e.g. street) of the person |
| `result.data.data.postal_address.street_number` | `string` | No | — | Street number of the person |
| `result.data.data.postal_address.subpremise` | `string` | No | — | Subpremise (e.g. apartment/suite number) of the person |
| `result.data.data.postal_address.postal_code` | `string` | No | — | Postal code of the person |
| `result.data.data.notes` | `string` | No | — | Contact sync notes of the person, maximum 10 000 characters, included if contact sync is enabled for the company |
| `result.data.data.im` | `array` | No | — | The instant messaging accounts of the person, included if contact sync is enabled for the company |
| `result.data.data.im[].value` | `string` | No | — | The instant messaging account of the person |
| `result.data.data.im[].primary` | `boolean` | No | — | Whether the instant messaging account is primary or not |
| `result.data.data.im[].label` | `string` | No | — | The instant messaging account classification label |
| `result.data.data.birthday` | `string` | No | — | The birthday of the person, included if contact sync is enabled for the company |
| `result.data.data.job_title` | `string` | No | — | The job title of the person, included if contact sync is enabled for the company |
| `result.data.data.custom_fields` | `record` | No | — | An object where each key represents a custom field. All custom fields are referenced as randomly generated 40-character hashes. To clear a custom field value, set it to `null`. For multi-option fields (field type `set`), use `null` to clear the selection — sending an empty array `[]` is not supported and will result in a validation error. |
| `result.meta` | `object` | No | — | Additional response metadata (status, paging). |
Show raw output schema
### Output JSON Schema
```json theme={null}
{
"type": "object",
"description": "Standard tool result payload.",
"properties": {
"data": {
"type": "object",
"description": "Provider response payload.",
"properties": {
"success": {
"type": "boolean",
"description": "If the response is successful or not"
},
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the person"
},
"name": {
"type": "string",
"description": "The name of the person"
},
"first_name": {
"type": "string",
"description": "The first name of the person"
},
"last_name": {
"type": "string",
"description": "The last name of the person"
},
"owner_id": {
"type": "integer",
"description": "The ID of the user who owns the person"
},
"org_id": {
"type": "integer",
"description": "The ID of the organization linked to the person"
},
"add_time": {
"type": "string",
"description": "The creation date and time of the person"
},
"update_time": {
"type": "string",
"description": "The last updated date and time of the person"
},
"emails": {
"type": "array",
"description": "The emails of the person",
"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"
}
},
"additionalProperties": false
}
},
"phones": {
"type": "array",
"description": "The phones of the person",
"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"
}
},
"additionalProperties": false
}
},
"is_deleted": {
"type": "boolean",
"description": "Whether the person is deleted or not"
},
"visible_to": {
"type": "integer",
"description": "The visibility of the person"
},
"label_ids": {
"type": "array",
"description": "The IDs of labels assigned to the person",
"items": {
"type": "integer"
}
},
"picture_id": {
"type": "integer",
"description": "The ID of the picture associated with the person"
},
"postal_address": {
"type": "object",
"description": "Postal address of the person, included if contact sync is enabled for the company",
"properties": {
"value": {
"type": "string",
"description": "The full address of the person"
},
"country": {
"type": "string",
"description": "Country of the person"
},
"admin_area_level_1": {
"type": "string",
"description": "Admin area level 1 (e.g. state) of the person"
},
"admin_area_level_2": {
"type": "string",
"description": "Admin area level 2 (e.g. county) of the person"
},
"locality": {
"type": "string",
"description": "Locality (e.g. city) of the person"
},
"sublocality": {
"type": "string",
"description": "Sublocality (e.g. neighborhood) of the person"
},
"route": {
"type": "string",
"description": "Route (e.g. street) of the person"
},
"street_number": {
"type": "string",
"description": "Street number of the person"
},
"subpremise": {
"type": "string",
"description": "Subpremise (e.g. apartment/suite number) of the person"
},
"postal_code": {
"type": "string",
"description": "Postal code of the person"
}
},
"additionalProperties": false
},
"notes": {
"type": "string",
"description": "Contact sync notes of the person, maximum 10 000 characters, included if contact sync is enabled for the company"
},
"im": {
"type": "array",
"description": "The instant messaging accounts of the person, included if contact sync is enabled for the company",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "The instant messaging account of the person"
},
"primary": {
"type": "boolean",
"description": "Whether the instant messaging account is primary or not"
},
"label": {
"type": "string",
"description": "The instant messaging account classification label"
}
},
"additionalProperties": false
}
},
"birthday": {
"type": "string",
"description": "The birthday of the person, included if contact sync is enabled for the company"
},
"job_title": {
"type": "string",
"description": "The job title of the person, included if contact sync is enabled for the company"
},
"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. To clear a custom field value, set it to `null`. For multi-option fields (field type `set`), use `null` to clear the selection — sending an empty array `[]` is not supported and will result in a validation error.",
"additionalProperties": true
}
},
"additionalProperties": false
}
},
"required": [],
"additionalProperties": false
},
"meta": {
"type": "object",
"description": "Additional response metadata (status, paging).",
"additionalProperties": true
}
},
"required": [
"data"
],
"additionalProperties": false
}
```
## Deepline cost
* Pricing model: `fixed` (per call).
* Estimated Deepline credits: `0` per pricing unit.
* Provider-native pricing may still exist outside Deepline credit billing.
## Related documentation
* [Pipedrive provider guide](/docs/providers/pipedrive/guide)
* [SDK V2 quickstart](/docs/sdk-v2/quickstart)
* [SDK reference](/docs/sdk-v2/sdk-reference)
* [Run tools across a CSV](/docs/sdk-v2/batch-csv)