Créer une personne avec l'API folk

Crée une personne, éventuellement dans des groupes et liée à des entreprises. folk fusionne les doublons en arrière-plan, ce qui peut écraser une partie des données envoyées. Une personne sans groupe n'apparaît que dans la recherche folk.

Identifiant
folk_create_person

L'appel

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

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

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
firstNamestringNonFirst name.
lastNamestringNonLast name.
fullNamestringNonFull name.
jobTitlestringNonJob title.
descriptionstringNonShort description of the person.
birthdaystringNonBirthday, as YYYY-MM-DD.
genderstringNonGender.Valeurs : Male, Female, Unknown, Other
emailsarrayNonEmail addresses. The first one is the primary email.
phonesarrayNonPhone numbers. The first one is the primary phone.
addressesarrayNonPostal addresses. The first one is the primary address.
urlsarrayNonWeb addresses, like a LinkedIn profile. The first one is the primary URL.
companiesarrayNonCompanies of the person, 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.
groupsarrayNonGroups to add the person to, by the id from List groups.
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_create_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.