Atualizar cliente no FreshBooks, por uma API

Altera os campos enviados de um cliente; os outros permanecem como estão. Os campos vão dentro de client.

Identificador
freshbooks_update_client

A chamada

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

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "account_id": "<account_id>",
    "client_id": 1,
    "client": {}
  }
}

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
account_idstringSimaccount_id of a business, from Get current user.
client_idintegerSimId of the client, from List clients or Create client.
clientobjectSimThe fields to change.

Conexões possíveis

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

OAuth com o app do seu produto

Você cadastra o app OAuth do seu produto uma vez, em POST /api/merchants/credentials/freshbooks, e o cliente autoriza a conta numa tela de consentimento. O Connect renova o token quando ele está para vencer.

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/freshbooks_update_client. Ele vira a definição de tool do seu agente sem conversão.

Outras tools do FreshBooks

Ver as 14 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.