Criar pessoa no folk, por uma API

Cria uma pessoa, opcionalmente em grupos e vinculada a empresas. O folk mescla duplicatas em segundo plano, o que pode sobrescrever parte dos dados enviados. Uma pessoa sem grupo só aparece na busca do folk.

Identificador
folk_create_person

A chamada

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

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

Seu sistema envia o id da conexão do cliente e os argumentos da tool. Os headers são os mesmos de toda a API do Connect: o token do seu produto e o token do cliente.

Parâmetros

As descrições dos parâmetros seguem a documentação oficial do app, em inglês.

ParâmetroTipoObrigatórioDescrição
firstNamestringNãoFirst name.
lastNamestringNãoLast name.
fullNamestringNãoFull name.
jobTitlestringNãoJob title.
descriptionstringNãoShort description of the person.
birthdaystringNãoBirthday, as YYYY-MM-DD.
genderstringNãoGender.Valores: Male, Female, Unknown, Other
emailsarrayNãoEmail addresses. The first one is the primary email.
phonesarrayNãoPhone numbers. The first one is the primary phone.
addressesarrayNãoPostal addresses. The first one is the primary address.
urlsarrayNãoWeb addresses, like a LinkedIn profile. The first one is the primary URL.
companiesarrayNãoCompanies of the person, 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.
groupsarrayNãoGroups to add the person to, by the id from List groups.
customFieldValuesobjectNãoCustom 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.

Conexões possíveis

O seu cliente conecta a conta do folk uma vez, por um dos modos abaixo. A mesma conexão serve para todas as tools do toolkit.

Chave de API

O cliente cola a chave do app numa tela do Connect, ou o seu sistema envia a chave por POST /api/customer-toolkits, sem tela.

A resposta

Em caso de sucesso, o Connect preserva o status e o corpo da resposta do app. Erros HTTP retornados pelo app usam o envelope {error, api_error}; falhas de autenticação ou validação podem ocorrer antes da execução. O header X-Toolkit-Execution-Id identifica a execução registrada, consultável em GET /api/tools/executions/{uuid}.

Pronta para agentes de IA

O input desta tool é um JSON Schema, disponível em GET /api/tools/folk_create_person. Ele vira a definição de tool do seu agente sem conversão.

Outras tools do folk

Ver as 13 tools

Toolkits da mesma categoria

Ver os 100 toolkits

Veja o Connect aplicado ao seu produto.

Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.