Créer un objet avec l'API folk

Crée un deal, ou un objet d'un autre type, dans un groupe. Les personnes et entreprises liées doivent déjà être dans le groupe, sinon folk les ignore. Un nom de champ personnalisé inconnu fait échouer toute la requête avec 422.

Identifiant
folk_create_object

L'appel

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

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "groupId": "<groupId>",
    "objectType": "<objectType>"
  }
}

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
groupIdstringOuiId of the group, starting with grp_, from List groups.
objectTypestringOuiName of the object type exactly as shown in folk, case-sensitive and with its spaces: Deals for deals, or another objectField name from List group custom fields.
namestringNonName of the deal or object.
peoplearrayNonPeople linked to the object, by the id from List people.
companiesarrayNonCompanies linked to the object, by the id from List companies.
customFieldValuesobjectNonMap from field name of the object type (List group custom fields with the object type as entityType) to value, like Status: Qualified. 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 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_object. 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.