People

Create person

post/people

Request

  • Base URL: https://api.pipelinecrm.com/api/v3
  • URL: https://api.pipelinecrm.com/api/v3/people
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer and API key in header app-key
    • API key in query parameter api_key and API key in query parameter app_key

Query parameters

deliver_reassignment_emailboolean

If true, and you are assigning the person to a different user, the system will send an assignment email to the new user. Setting it to false will disable sending an assignment email.

Request body

todo_template_idinteger

The ID of the todo template to apply to this person

todo_template_user_idinteger

The owner of any tasks created by applying the given todo template

deliver_assignment_email'true' | 'false'

Create. Sits beside person, not inside it (also accepted as a query parameter). Pass "false" to skip the email normally sent when the record is assigned to another user.

deliver_reassignment_email'true' | 'false'

Update. Sits beside person, not inside it. Pass "false" to skip the email normally sent when user_id changes to another user.

do_not_validate_email'true' | 'false'

Sits beside person, not inside it. Pass "true" to save a person whose email would otherwise be rejected as malformed.

Example request

{
  "person": {
    "created_at": "2026-09-01 14:22:07",
    "updated_at": "2026-09-01 14:22:07",
    "first_name": "Jane",
    "last_name": "Rivera",
    "full_name": "Jane Rivera",
    "summary": "Owns the renewal decision; prefers email.",
    "phone": "+1 415 555 0142",
    "home_phone": "123-123-1234",
    "mobile": "+1 415 555 0177",
    "position": "Head of Operations",
    "website": "http://www.james-smith.com",
    "email": "jane.rivera@acme.example",
    "email2": "james.smith@acme-inc.com",
    "home_email": "james.smith@gmail.com",
    "company_id": 3310,
    "company_name": "Acme Corporation",
    "user_id": 13,
    "lead_status_id": 2,
    "lead_source_id": 5,
    "image_thumb_url": "https://s3.amazonaws.com/avatar.png",
    "predefined_contacts_tag_ids": [
      3,
      4,
      5
    ],
    "work_address_1": "Suite 101",
    "work_address_2": "123 Fake St.",
    "work_city": "Denver",
    "work_state": "Colorado",
    "work_country": "United States",
    "home_address_1": "Suite 101.",
    "home_address_2": "123 Fake St.",
    "home_city": "Denver",
    "home_state": "Colorado",
    "home_country": "United States",
    "facebook_url": "https://www.facebook.com/james.smith",
    "linked_in_url": "https://www.linkedin.com/in/james-smith-101",
    "twitter": "james.smith",
    "instant_message": "james_smith_20",
    "last_emailed_at": "2020-02-07 15:26:10 -0500",
    "custom_fields": {
      "custom_label_90": [
        45,
        46,
        47
      ],
      "custom_label_5": "text val"
    },
    "shared_user_ids": [
      1,
      2,
      3
    ],
    "relationship": "Owner",
    "is_key_contact": true,
    "type": "Contact",
    "deal_ids": [
      4521
    ],
    "created_by_user_id": 13
  },
  "todo_template_id": 1,
  "todo_template_user_id": 13473,
  "deliver_assignment_email": "false",
  "deliver_reassignment_email": "false",
  "do_not_validate_email": "false"
}

Response

Successful Response

idinteger

Unique identifier

ownerstring

The owner's full name, or N/A when the record has no owner.

is_sampleboolean

Marks a record created by the sample-data generator.

viewed_atstring nullable

When the caller last opened the record in the app.

project_shared_user_idsinteger[]

Users who see the record through a shared project.

has_work_addressboolean
has_home_addressboolean
has_company_addressboolean

When true, the company_address_1, company_address_2, company_city, company_state, company_postal_code and company_country fields are present.

work_address_google_maps_urlstring nullable
home_address_google_maps_urlstring nullable
company_address_google_maps_urlstring nullable
company_address_1string nullable

Present when has_company_address is true.

company_address_2string nullable

Present when has_company_address is true.

company_citystring nullable

Present when has_company_address is true.

company_statestring nullable

Present when has_company_address is true.

company_postal_codestring nullable

Present when has_company_address is true.

company_countrystring nullable

Present when has_company_address is true.

date_of_first_activitystring nullable

Deal Intelligence. Present for accounts with the feature enabled.

days_since_last_activityinteger nullable

Deal Intelligence. Present for accounts with the feature enabled.

hours_to_first_activitystring nullable

Deal Intelligence, decimal hours serialized as a string. Present for accounts with the feature enabled.

image_mobile_urlstring

A link to the person's mobile avatar. Mobile avatar is scaled to maximum of 100x100 pixels.

possible_notify_user_idsinteger[]

The list of User IDs that can be added to notify_user_ids on associated notes.

next_entry_namestring nullable

Name of the next calendar entry due associated with the person

next_entry_idinteger nullable

The ID of the next calendar entry due associated with the person

next_entry_duestring nullable

Due date of the next calendar entry due associated with the person

next_entry_all_dayboolean nullable

Is the next calendar entry due associated with the person an all day event?

created_atstring

Timestamp when the record was created (time zone in user's time zone).

updated_atstring

Timestamp when the record was last touched (time zone in user's time zone).

first_namestring nullable

The person's first name.

last_namestring nullable

The person's last name.

full_namestring

The person's full name. Will split on whitespace to set first_name and last_name fields

summarystring nullable

Summary or notes on the person.

phonestring nullable

Person's primary phone number

home_phonestring nullable

Person's home phone number

mobilestring nullable

Person's mobile phone number

positionstring nullable

Person's professional position

websitestring nullable

Person's website URL

emailstring nullable

Person's primary email address

email2string nullable

Person's secondary email address

home_emailstring nullable

Person's non-professional email address

company_idinteger nullable

The ID of the company associated to this person

company_namestring nullable

Associates the company with this name to this person, creating it if none matches.

user_idinteger

The ID of the user who owns this person record

lead_status_idinteger

The ID of the lead status to set for this person

lead_source_idinteger

The ID of the lead source to set for this person

image_thumb_urlstring

A link to the person's avatar. Avatar is scaled to maximum of 50x50 pixels.

predefined_contacts_tag_idsinteger[]

IDs of the tags to set on this person

work_address_1string nullable

First line of work address.

work_address_2string nullable

Second line of work address.

work_citystring nullable

Work address city.

work_statestring nullable

Work address state.

work_countrystring nullable

Work address country.

work_postal_codestring nullable

Work address postal code.

home_address_1string nullable

First line of Home address.

home_address_2string nullable

Second line of Home address.

home_citystring nullable

Home address city.

home_statestring nullable

Home address state.

home_countrystring nullable

Home address country.

home_postal_codestring nullable

Home address postal code.

facebook_urlstring nullable

URL to person's facebook profile

linked_in_urlstring nullable

URL to person's LinkedIn profile

twitterstring nullable

Person's twitter username

instant_messagestring nullable

Person's IM username

unsubscribedboolean

Whether or not the person has unsubscribed to newsletters

bouncedboolean

Whether or not the person has had emails sent to them bounce

last_emailed_atstring nullable

When the person was last emailed timestamp

custom_fieldsobject

Custom fields for the person. See custom fields section for more info.

shared_user_idsinteger[]

The array of User IDs with whom this person's been shared (also known as Collaborators)

relationshipstring

The relationship of the person to the company (e.g. "Father", "CEO", "Owner", etc.)

is_key_contactboolean

Whether or not this person is a key contact for the company

type'Contact' | 'Lead'

Whether the record is a contact or a lead. Setting it on update converts the record.

deal_idsinteger[]

The deals the person is associated with. Set to the full list; deals left out are disassociated.

faxstring nullable
created_by_user_idinteger nullable

The user recorded as the creator. Defaults to the authenticated user.

Example response

{
  "id": 8802,
  "user": {
    "id": 13,
    "first_name": "Sam",
    "last_name": "Okafor"
  },
  "owner": "Sam Okafor",
  "created_by_user": {
    "id": 13,
    "first_name": "Sam",
    "last_name": "Okafor"
  },
  "company": {
    "id": 3310,
    "name": "Acme Corporation"
  },
  "deals": [
    {
      "id": 4521,
      "name": "Acme renewal"
    }
  ],
  "currency": {
    "id": 1,
    "name": "US Dollar",
    "code": "USD",
    "symbol": "$",
    "decimal_places": 2
  },
  "project_shared_user_ids": [],
  "has_work_address": true,
  "lead_status": {
    "id": 2,
    "name": "Qualified",
    "hex_color": "#4EB571"
  },
  "lead_source": {
    "id": 5,
    "name": "Website"
  },
  "image_mobile_url": "https://s3.amazonaws.com/avatar.png",
  "predefined_contacts_tags": [
    {
      "id": 2,
      "name": "Decision maker"
    }
  ],
  "possible_notify_user_ids": [
    1,
    2,
    3,
    4,
    5
  ],
  "next_entry_name": "Send revised quote",
  "next_entry_id": 5602,
  "next_entry_due": "2026/09/08",
  "created_at": "2026-09-01 14:22:07",
  "updated_at": "2026-09-01 14:22:07",
  "first_name": "Jane",
  "last_name": "Rivera",
  "full_name": "Jane Rivera",
  "summary": "Owns the renewal decision; prefers email.",
  "phone": "+1 415 555 0142",
  "home_phone": "123-123-1234",
  "mobile": "+1 415 555 0177",
  "position": "Head of Operations",
  "website": "http://www.james-smith.com",
  "email": "jane.rivera@acme.example",
  "email2": "james.smith@acme-inc.com",
  "home_email": "james.smith@gmail.com",
  "company_id": 3310,
  "company_name": "Acme Corporation",
  "user_id": 13,
  "lead_status_id": 2,
  "lead_source_id": 5,
  "image_thumb_url": "https://s3.amazonaws.com/avatar.png",
  "predefined_contacts_tag_ids": [
    3,
    4,
    5
  ],
  "work_address_1": "Suite 101",
  "work_address_2": "123 Fake St.",
  "work_city": "Denver",
  "work_state": "Colorado",
  "work_country": "United States",
  "home_address_1": "Suite 101.",
  "home_address_2": "123 Fake St.",
  "home_city": "Denver",
  "home_state": "Colorado",
  "home_country": "United States",
  "facebook_url": "https://www.facebook.com/james.smith",
  "linked_in_url": "https://www.linkedin.com/in/james-smith-101",
  "twitter": "james.smith",
  "instant_message": "james_smith_20",
  "last_emailed_at": "2020-02-07 15:26:10 -0500",
  "custom_fields": {
    "custom_label_90": [
      45,
      46,
      47
    ],
    "custom_label_5": "text val"
  },
  "shared_user_ids": [
    1,
    2,
    3
  ],
  "relationship": "Owner",
  "is_key_contact": true,
  "type": "Contact",
  "deal_ids": [
    4521
  ],
  "created_by_user_id": 13
}

Changes

No recorded changes to this operation across all 1 revision of this API.