Atualizar pessoa no Conta Azul, por uma API

Atualiza parte de uma pessoa: só os campos enviados mudam. Para alterar um endereço existente, envie o id dele obtido em Obter pessoa.

Identificador
conta_azul_update_person

A chamada

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

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

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
idstringSimId of the person (UUID), from List people or Create person.
nomestringNãoName of the person or legal name of the company.
tipo_pessoastringNãoFísica (individual), Jurídica (company) or Estrangeira (foreign).Valores: Física, Jurídica, Estrangeira
perfisarrayNãoProfiles of the person, for example one item with tipo_perfil Cliente for a customer.
cpfstringNãoCPF of an individual, for example 123.456.789-00.
cnpjstringNãoCNPJ of a company, for example 12.345.678/0001-90.
nome_empresastringNãoTrade name of a company.
emailstringNãoEmail addresses of the person, separated by commas.
telefone_celularstringNãoCell phone with area code, digits only, for example 11987654321.
telefone_comercialstringNãoBusiness phone with area code, digits only.
codigostringNãoCode of the person in your own system.
observacaostringNãoNotes about the person.
ativobooleanNãofalse makes the person inactive, and true active again.
enderecosarrayNãoAddresses of the person. An item with id changes that address.

Conexões possíveis

O seu cliente conecta a conta do Conta Azul 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/conta_azul, 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/conta_azul_update_person. Ele vira a definição de tool do seu agente sem conversão.

Outras tools do Conta Azul

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.