--remove-company to detach the current company. Pass --company-id or --company-name to reassign.
Synopsis
Arguments
| Argument | Type | Description |
|---|---|---|
<id> | integer | Person ID to update. |
Options
| Flag | Type | Description |
|---|---|---|
--first-name <name> | string | Replace the first name. |
--last-name <name> | string | Replace the last name. |
--primary-email <email> | string | Set the primary email. Must already exist on the record or be added in the same call via --email. |
--email <email> | string (repeatable) | Replace the email list. Repeat for each address. |
--primary-phone <phone> | string | Set the primary phone. |
--phone <phone> | string (repeatable) | Replace the phone list. Repeat for each number. |
--job-title <title> | string | Replace the job title. |
--address <address> | string | Replace the address. |
--avatar-url <url> | string | Replace the avatar URL. |
--linkedin-url <url> | string | Replace the LinkedIn URL. |
--x-url <url> | string | Replace the X (formerly Twitter) URL. |
--company-name <name> | string | Assign or rename the company by display name. |
--company-id <id> | integer | Assign the company by ID. |
--remove-company | flag | Detach the current company. Do not combine with --company-name / --company-id. |
Examples
1. Update a single field
jobTitle changes server-side.
2. Replace the email list and set the primary
3. Detach a company in a script
jq -e exits non-zero if the assertion fails, so the script halts when the detach did not take effect.
Response
The full updated record comes back, matching the shape ofperson get:
Troubleshooting
--primary-emailis not on the record. The address you pass to--primary-emailmust already exist on the person or be added in the same call via--email. Otherwise the command exits non-zero without writing.--remove-companycombined with a company assignment. Passing--remove-companyalongside--company-idor--company-nameis rejected and the command exits non-zero. Choose one.
See also
person list. Find the ID first.person get. Inspect the record before and after.person activity. See who changed what and when.person merge. Combine duplicate records.- People. The dashboard surface this command mirrors.
