Create a person

Create a new person (contact/lead) in your team. People are automatically deduplicated by email address.

Use Cases:

  • Add leads from website forms
  • Import contacts from external systems
  • Create prospects manually
  • Sync contacts from marketing platforms

Deduplication:

  • If an email address already exists, the existing person will be returned
  • Use PUT /people/{id} to update existing contacts

Required vs Optional:

  • At minimum, provide either firstName/lastName OR name
  • Emails and phones are optional but recommended for communication
  • Tags can be added during creation for immediate categorization

Idempotency: This endpoint participates in automatic idempotent-replay — see the "Idempotency" section of the API overview for the full semantics (30-second window, X-Idempotent-Replay: true header, failure/retry behavior).

Example - Minimal Contact:

{
  "firstName": "Jane",
  "lastName": "Doe",
  "emails": [{"value": "[email protected]", "isPrimary": true}]
}

Example - Full Contact:

{
  "firstName": "John",
  "lastName": "Smith",
  "companyName": "Acme Corp",
  "stage": "Lead",
  "source": "Website Form",
  "emails": [
    {"value": "[email protected]", "type": "work", "isPrimary": true}
  ],
  "phones": [
    {"value": "+1-555-1234", "type": "mobile", "isPrimary": true}
  ],
  "addresses": [
    {
      "type": "work",
      "street": "123 Business St",
      "city": "Portland",
      "state": "OR",
      "code": "97201"
    }
  ],
  "tags": ["hot-lead", "buyer"],
  "assignedUserId": "user-uuid-here"
}
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string

First name

string

Last name

string

Full name (use this OR firstName/lastName)

uuid | null

Assign to a specific user. Only one of assignedUserId, assignedPondId, or assignedGroupId may be provided.

uuid | null

Assign to a specific pond. Only one of assignedUserId, assignedPondId, or assignedGroupId may be provided.

uuid | null

Assign to a specific group. Only one of assignedUserId, assignedPondId, or assignedGroupId may be provided.

string

Sales pipeline stage

string

Lead source

string

Company name

number

Property price interest (real estate)

emails
array of objects

Email addresses - can provide multiple

emails
phones
array of objects

Phone numbers - can provide multiple in any format

phones
addresses
array of objects

Physical addresses - can provide multiple

addresses
tags
array of strings

Tags for categorization - tags are created if they don't exist

tags
Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json