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:

  • A name is required: provide either firstName/lastName OR name
  • At least one contact method is required: provide emails OR phones (or both)
  • 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)

string
length ≤ 255

Your system's ID for this contact. Values starting with the reserved prefixes 'user:' or 'ss_team:' are rejected with 422.

string
length ≤ 255

System the contact originated in. Origin fields can only be set here, at create.

string
length ≤ 255

The contact's ID in the originating system

string
length ≤ 255

The originating agent's ID in the originating system. Kept when the contact is reassigned.

string
length ≤ 255

The originating agent's name

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