Update person with the folk API

Updates a person, changing only the fields sent. A list (groups, companies, emails, phones, addresses, urls) replaces the current one, so send it whole. Leaving a group out removes the person from it, along with their custom field values in that group.

Identifier
folk_update_person

The request

POST https://connect.reportei.com/api/tools/folk_update_person/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "personId": "<personId>"
  }
}

Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.

Parameters

ParameterTypeRequiredDescription
personIdstringYesId of the person, starting with per_, from List people.
firstNamestringNoFirst name.
lastNamestringNoLast name.
fullNamestringNoFull name.
jobTitlestringNoJob title.
descriptionstringNoShort description of the person.
birthdaystringNoBirthday, as YYYY-MM-DD. An empty string removes it.
genderstringNoGender.Values: Male, Female, Unknown, Other
emailsarrayNoAll the email addresses of the person, replacing the current list. The first one is the primary email.
phonesarrayNoAll the phone numbers, replacing the current list. The first one is the primary phone.
addressesarrayNoAll the postal addresses, replacing the current list. The first one is the primary address.
urlsarrayNoAll the web addresses, replacing the current list. The first one is the primary URL.
companiesarrayNoAll the companies of the person, replacing the current list, each with the id from List companies or a name. A name that does not exist creates the company. The first one is the primary company.
groupsarrayNoAll the groups of the person, by the id from List groups, replacing the current list. A group left out is removed with its custom field values.
customFieldValuesobjectNoCustom field values by group id, each group also listed in groups: a map from field name (List group custom fields) to value. Text, number, YYYY-MM-DD date, the exact option label of a single select or a list of labels (an unknown label creates a new option), and a list of objects with id, or with id or email for user fields. null clears a value.

Supported connections

Your customer connects their folk account once, with one of the modes below. The same connection serves every tool of the toolkit.

API key

Your customer pastes the app's key on a Connect screen, or your system sends the key with POST /api/customer-toolkits, with no screen.

The response

On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.

Ready for AI agents

This tool's input is a JSON Schema, available at GET /api/tools/folk_update_person. It becomes your agent's tool definition with no conversion.

Other folk tools

See all 13 tools

Toolkits in the same category

See all 100 toolkits

See Connect applied to your product.

Try it for 15 days with no card, or walk our team through your use case.