Créer une note avec l'API folk
Ajoute une note à une personne, une entreprise ou un objet comme un deal. Le contenu accepte le Markdown.
- Identifiant
- folk_create_note
L'appel
POST https://connect.reportei.com/api/tools/folk_create_note/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"entity": {},
"visibility": "public",
"content": "<content>"
}
}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ètre | Type | Obligatoire | Description |
|---|---|---|---|
| entity | object | Oui | Record the note belongs to. |
| visibility | string | Oui | public shows the note to every user of the workspace; private only to the user of the API key.Valeurs : public, private |
| content | string | Oui | Text of the note, plain or in Markdown. |
| parentNote | object | Non | Note this one replies to. |
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_note. Il devient la définition de tool de votre agent sans conversion.
Autres tools folk
- Lister les groupesGETListe les groupes du workspace avec id et nom. Les groupes contiennent des personnes, des entreprises et des deals. La page suivante vient du curseur dans pagination.nextLink ; la dernière page n'a pas de nextLink.
- Lister les champs personnalisés d'un groupeGETListe les champs personnalisés d'un groupe pour les personnes, les entreprises ou un type d'objet, avec nom, type et options des champs de sélection. Sur personne ou entreprise, chaque champ de type objectField est un type d'objet du groupe, comme Deals, et son nom est l'objectType des outils d'objet.
- Lister les personnesGETListe les personnes du workspace avec id, noms, e-mails, téléphones, poste, entreprises, groupes et valeurs des champs personnalisés. La page suivante vient du curseur dans pagination.nextLink ; la dernière page n'a pas de nextLink.
- Créer une personnePOSTCré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.
- Mettre à jour une personnePATCHMet à 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.
- Lister les entreprisesGETListe les entreprises du workspace avec id, nom, secteur, e-mails, téléphones, URL, groupes et valeurs des champs personnalisés. La page suivante vient du curseur dans pagination.nextLink ; la dernière page n'a pas de nextLink.
- Créer une entreprisePOSTCrée une entreprise, éventuellement dans des groupes. Les noms sont uniques dans le workspace : un nom existant renvoie cette entreprise au lieu d'en créer une autre. Une entreprise sans groupe n'apparaît que dans la recherche folk.
- Mettre à jour une entreprisePATCHMet à jour une entreprise, en ne modifiant que les champs envoyés. Une liste (groups, emails, phones, addresses, urls) remplace l'actuelle, envoyez-la donc en entier. Omettre un groupe retire l'entreprise de ce groupe, avec les valeurs de ses champs personnalisés dans ce groupe. Un nom déjà utilisé par une autre entreprise échoue.
Toolkits de la même catégorie
Voir les 100 toolkitsVoyez Connect appliqué à votre produit.
Essayez-le pendant 15 jours sans carte, ou présentez votre cas à notre équipe.
