Update a person

Update an existing person. Only provide fields you want to change - all fields are optional.

Partial Updates:

  • Only include fields you want to update
  • Omitted fields will remain unchanged
  • To clear a field, send null or empty string

Assignment:

  • Send assignedUserId, assignedPondId, or assignedGroupId with a valid UUID to assign
  • Only one assignment type may be provided at a time
  • Send any assignment field as null or "" to clear/unassign the person
  • Omit all assignment fields entirely to leave the current assignment unchanged

Tag Handling:

  • Use mergeTags=true to add tags without removing existing ones
  • Use mergeTags=false (or omit) to replace all tags
  • For more control, use the dedicated tag endpoints: /people/{id}/tags/apply and /people/{id}/tags/delete

Email Handling:

  • Use mergeEmails=true to add new emails and update existing ones without removing others
  • Use mergeEmails=false (or omit) to replace all emails

Phone Handling:

  • Use mergePhones=true to add new phones and update existing ones without removing others
  • Use mergePhones=false (or omit) to replace all phones

Examples:

Update Name and Stage:

{
  "firstName": "Jane",
  "stage": "Qualified"
}

Add Tags (with mergeTags=true):

{
  "tags": ["buyer", "active"]
}

Replace All Tags (with mergeTags=false or omitted):

{
  "tags": ["archived"]
}
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

Person ID

Query Params
boolean

If true, merge tags with existing tags. If false (default), replace all tags.

boolean

If true, merge emails with existing (add new, update matching). If false (default), replace all emails.

boolean

If true, merge phones with existing (add new, update matching). If false (default), replace all phones.

Body Params
string

First name

string

Last name

string

Company name

Assign to a specific user by ID. Send null or empty string to clear/unassign. Only one of assignedUserId, assignedPondId, or assignedGroupId may be provided.

Assign to a specific pond by ID. Send null or empty string to clear/unassign. Only one of assignedUserId, assignedPondId, or assignedGroupId may be provided.

Assign to a specific group by ID. Send null or empty string to clear/unassign. Only one of assignedUserId, assignedPondId, or assignedGroupId may be provided.

string

Sales pipeline stage

tags
array of strings

Tags (behavior depends on mergeTags parameter)

tags
emails
array of objects

Email addresses. Default: REPLACES all existing emails. Use mergeEmails=true to add/update without removing existing.

emails
phones
array of objects

Phone numbers. Default: REPLACES all existing phones. Use mergePhones=true to add/update without removing existing.

phones
addresses
array of objects

Physical addresses. ⚠️ REPLACES all existing addresses. To update one address while keeping others, include the complete list.

addresses
Responses
200

person updated

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