Skip to main content
Patch any combination of fields on a person record. Only the flags you pass are written. Omitted fields stay untouched. Pass --remove-company to detach the current company. Pass --company-id or --company-name to reassign.

Synopsis

Arguments

Options

Examples

1. Update a single field

Prints the updated record as a table. Only jobTitle changes server-side.

2. Replace the email list and set the primary

Replaces the full email list and sets the primary in one call.

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 of person get:

Troubleshooting

  • --primary-email is not on the record. The address you pass to --primary-email must already exist on the person or be added in the same call via --email. Otherwise the command exits non-zero without writing.
  • --remove-company combined with a company assignment. Passing --remove-company alongside --company-id or --company-name is rejected and the command exits non-zero. Choose one.
See Exit codes for the full mapping.

See also