Créer une entreprise avec l'API folk

Cré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.

Identifiant
folk_create_company

L'appel

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

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

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
namestringNonName of the company, unique in the workspace.
descriptionstringNonShort description of the company.
industrystringNonIndustry, like Technology.
employeeRangestringNonNumber of employees.Valeurs : 1-10, 11-50, 51-200, 201-500, 501-1000, 1001-5000, 5001-10000, 10000+
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 the company website. The first one is the primary URL.
groupsarrayNonGroups to add the company 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_company. 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.