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ètreTypeObligatoireDescription
entityobjectOuiRecord the note belongs to.
visibilitystringOuipublic shows the note to every user of the workspace; private only to the user of the API key.Valeurs : public, private
contentstringOuiText of the note, plain or in Markdown.
parentNoteobjectNonNote 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

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.