Atualizar empresa no folk, por uma API

Atualiza uma empresa, alterando apenas os campos enviados. Uma lista (groups, emails, phones, addresses, urls) substitui a atual, então envie-a completa. Deixar um grupo de fora remove a empresa dele, junto com os valores dos campos personalizados nesse grupo. Um nome já usado por outra empresa falha.

Identificador
folk_update_company

A chamada

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

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

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
companyIdstringSimId of the company, starting with com_, from List companies.
namestringNãoName of the company, unique in the workspace.
descriptionstringNãoShort description of the company.
industrystringNãoIndustry, like Technology.
employeeRangestringNãoNumber of employees.Valores: 1-10, 11-50, 51-200, 201-500, 501-1000, 1001-5000, 5001-10000, 10000+
emailsarrayNãoAll the email addresses of the company, replacing the current list. The first one is the primary email.
phonesarrayNãoAll the phone numbers, replacing the current list. The first one is the primary phone.
addressesarrayNãoAll the postal addresses, replacing the current list. The first one is the primary address.
urlsarrayNãoAll the web addresses, replacing the current list. The first one is the primary URL.
groupsarrayNãoAll the groups of the company, by the id from List groups, replacing the current list. A group left out is removed with its custom field values.
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_update_company. 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.