Actualizar objeto en folk, con una API

Actualiza un negocio u otro objeto, cambiando solo los campos enviados. people y companies sustituyen las listas actuales, así que envíalas completas. Mover un negocio en el pipeline es un cambio del campo personalizado Status.

Identificador
folk_update_object

La llamada

POST https://connect.reportei.com/api/tools/folk_update_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>",
    "objectId": "<objectId>"
  }
}

Tu sistema envía el id de la conexión de tu cliente y los argumentos de la tool. Los headers son los mismos de toda la API de Connect: el token de tu producto y el token de tu cliente.

Parámetros

Las descripciones de los parámetros siguen la documentación oficial de la app, en inglés.

ParámetroTipoObligatorioDescripción
groupIdstringSíId of the group, starting with grp_, from List groups.
objectTypestringSíName 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.
objectIdstringSíId of the deal or object, from List objects.
namestringNoName of the deal or object.
peoplearrayNoAll the people linked to the object, by the id from List people, replacing the current list.
companiesarrayNoAll the companies linked to the object, by the id from List companies, replacing the current list.
customFieldValuesobjectNoMap 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.

Conexiones posibles

Tu cliente conecta su cuenta de folk una sola vez, con uno de los modos de abajo. La misma conexión sirve para todas las tools del toolkit.

Clave de API

Tu cliente pega la clave de la app en una pantalla de Connect, o tu sistema envía la clave con POST /api/customer-toolkits, sin pantalla.

La respuesta

Si la llamada tiene éxito, Connect conserva el status y el cuerpo de la respuesta de la app. Los errores HTTP devueltos por la app usan el objeto {error, api_error}; la autenticación o validación pueden fallar antes de la ejecución. El header X-Toolkit-Execution-Id identifica la ejecución registrada, disponible en GET /api/tools/executions/{uuid}.

Lista para agentes de IA

El input de esta tool es un JSON Schema, disponible en GET /api/tools/folk_update_object. Se convierte en la definición de tool de tu agente sin conversión.

Otras tools de folk

Ver las 13 tools

Toolkits de la misma categoría

Ver los 100 toolkits

Mira Connect aplicado a tu producto.

Pruébalo durante 15 días sin tarjeta, o cuéntale tu caso a nuestro equipo.