Mettre à jour une personne avec l'API Conta Azul

Met à jour une partie d'une personne : seuls les champs envoyés changent. Pour modifier une adresse existante, envoyez son id obtenu avec Obtenir une personne.

Identifiant
conta_azul_update_person

L'appel

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>"
  }
}

Votre système envoie l'id de la connexion de votre client et les arguments de la tool. Les headers sont les mêmes que pour toute l'API Connect : le token de votre produit et celui de votre client.

Paramètres

Les descriptions des paramètres suivent la documentation officielle de l'app, en anglais.

ParamètreTypeObligatoireDescription
idstringOuiId of the person (UUID), from List people or Create person.
nomestringNonName of the person or legal name of the company.
tipo_pessoastringNonFísica (individual), Jurídica (company) or Estrangeira (foreign).Valeurs : Física, Jurídica, Estrangeira
perfisarrayNonProfiles of the person, for example one item with tipo_perfil Cliente for a customer.
cpfstringNonCPF of an individual, for example 123.456.789-00.
cnpjstringNonCNPJ of a company, for example 12.345.678/0001-90.
nome_empresastringNonTrade name of a company.
emailstringNonEmail addresses of the person, separated by commas.
telefone_celularstringNonCell phone with area code, digits only, for example 11987654321.
telefone_comercialstringNonBusiness phone with area code, digits only.
codigostringNonCode of the person in your own system.
observacaostringNonNotes about the person.
ativobooleanNonfalse makes the person inactive, and true active again.
enderecosarrayNonAddresses of the person. An item with id changes that address.

Connexions possibles

Votre client connecte son compte Conta Azul une seule fois, avec l'un des modes ci-dessous. La même connexion sert à toutes les tools du toolkit.

OAuth avec l'app de votre produit

Vous enregistrez une fois l'app OAuth de votre produit, avec POST /api/merchants/credentials/conta_azul, et votre client autorise le compte sur un écran de consentement. Connect renouvelle le token avant son expiration.

La réponse

En cas de succès, Connect conserve le statut et le corps de la réponse de l'app. Les erreurs HTTP renvoyées par l'app utilisent l'objet {error, api_error} ; l'authentification ou la validation peuvent échouer avant l'exécution. Le header X-Toolkit-Execution-Id identifie l'exécution enregistrée, consultable avec GET /api/tools/executions/{uuid}.

Prête pour les agents IA

L'input de cette tool est un JSON Schema, disponible via GET /api/tools/conta_azul_update_person. Il devient la définition de tool de votre agent sans conversion.

Autres tools Conta Azul

Voir les 13 tools

Toolkits de la même catégorie

Voir les 100 toolkits

Voyez Connect appliqué à votre produit.

Essayez-le pendant 15 jours sans carte, ou présentez votre cas à notre équipe.