Actualizar persona en folk, con una API

Actualiza una persona, cambiando solo los campos enviados. Una lista (groups, companies, emails, phones, addresses, urls) sustituye a la actual, así que envíala completa. Dejar un grupo fuera quita a la persona de él, junto con los valores de sus campos personalizados en ese grupo.

Identificador
folk_update_person

La llamada

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

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

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
personIdstringSíId of the person, starting with per_, from List people.
firstNamestringNoFirst name.
lastNamestringNoLast name.
fullNamestringNoFull name.
jobTitlestringNoJob title.
descriptionstringNoShort description of the person.
birthdaystringNoBirthday, as YYYY-MM-DD. An empty string removes it.
genderstringNoGender.Valores: Male, Female, Unknown, Other
emailsarrayNoAll the email addresses of the person, replacing the current list. The first one is the primary email.
phonesarrayNoAll the phone numbers, replacing the current list. The first one is the primary phone.
addressesarrayNoAll the postal addresses, replacing the current list. The first one is the primary address.
urlsarrayNoAll the web addresses, replacing the current list. The first one is the primary URL.
companiesarrayNoAll the companies of the person, replacing the current list, each with the id from List companies or a name. A name that does not exist creates the company. The first one is the primary company.
groupsarrayNoAll the groups of the person, by the id from List groups, replacing the current list. A group left out is removed with its custom field values.
customFieldValuesobjectNoCustom 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.

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_person. 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.