Mettre à jour une personne avec l'API folk

Met à jour une personne, en ne modifiant que les champs envoyés. Une liste (groups, companies, emails, phones, addresses, urls) remplace l'actuelle, envoyez-la donc en entier. Omettre un groupe retire la personne de ce groupe, avec les valeurs de ses champs personnalisés dans ce groupe.

Identifiant
folk_update_person

L'appel

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>"
  }
}

Votre système envoie l'id de la connexion de votre client et les arguments de la tool. Les headers sont les mêmes que pour toute l'API Connect : le token de votre produit et celui de votre client.

Paramètres

Les descriptions des paramètres suivent la documentation officielle de l'app, en anglais.

ParamètreTypeObligatoireDescription
personIdstringOuiId of the person, starting with per_, from List people.
firstNamestringNonFirst name.
lastNamestringNonLast name.
fullNamestringNonFull name.
jobTitlestringNonJob title.
descriptionstringNonShort description of the person.
birthdaystringNonBirthday, as YYYY-MM-DD. An empty string removes it.
genderstringNonGender.Valeurs : Male, Female, Unknown, Other
emailsarrayNonAll the email addresses of the person, replacing the current list. The first one is the primary email.
phonesarrayNonAll the phone numbers, replacing the current list. The first one is the primary phone.
addressesarrayNonAll the postal addresses, replacing the current list. The first one is the primary address.
urlsarrayNonAll the web addresses, replacing the current list. The first one is the primary URL.
companiesarrayNonAll 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.
groupsarrayNonAll 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.
customFieldValuesobjectNonCustom 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.

Connexions possibles

Votre client connecte son compte folk une seule fois, avec l'un des modes ci-dessous. La même connexion sert à toutes les tools du toolkit.

Clé d'API

Votre client colle la clé de l'app sur un écran de Connect, ou votre système envoie la clé avec POST /api/customer-toolkits, sans écran.

La réponse

En cas de succès, Connect conserve le statut et le corps de la réponse de l'app. Les erreurs HTTP renvoyées par l'app utilisent l'objet {error, api_error} ; l'authentification ou la validation peuvent échouer avant l'exécution. Le header X-Toolkit-Execution-Id identifie l'exécution enregistrée, consultable avec GET /api/tools/executions/{uuid}.

Prête pour les agents IA

L'input de cette tool est un JSON Schema, disponible via GET /api/tools/folk_update_person. Il devient la définition de tool de votre agent sans conversion.

Autres tools folk

Voir les 13 tools

Toolkits de la même catégorie

Voir les 100 toolkits

Voyez Connect appliqué à votre produit.

Essayez-le pendant 15 jours sans carte, ou présentez votre cas à notre équipe.