Skip to content

Update Account

Endpoint used to update the account data linked to the institution.

Terminal window
curl --request PUT \
--url https://chat.api.toolzz.com.br/api/v1/auth/update/{id} \
--header 'Authorization: Bearer TOKEN_HERE' \
--header 'Content-Type: application/json' \
--data '{
"name": "name",
"lastName": "lastname",
"phone": "+5511999999999"
}'
{
"id": "12345678-abcd-efgh-ijkl-1234567890ab",
"name": "John",
"lastName": "Doe",
"email": "john.doe@provider.com.br",
"phone": "11999999999",
"imgProfileId": "img_789456",
"imgProfile": [],
"hasFinishedOnboarding": true
}
ParameterTypeDescriptionRequired
AuthorizationStringAccess token (“Bearer” must be before the token)Yes
ParameterTypeDescriptionRequired
idStringUser account IDYes
ParameterTypeDescriptionRequired
nameStringUser’s nameYes
lastNameStringUser’s last nameYes
phoneStringUser’s phoneNo

KeyTypeDescriptionRequired
idUUIDUnique and immutable identifier of the user.Yes
nameStringUser’s first name.Yes
lastNameStringLast name or family name.Yes
emailStringEmail address (must be unique).Yes
phoneStringPhone number with area code.No
imgProfileIdStringUnique reference to the image in storage.No
imgProfileArrayList of metadata or image paths.No
hasFinishedOnboardingBooleanDefines if the user has already gone through the initial tutorial.No

To access this endpoint, it is necessary to send a valid access token through the authorization header (Authorization) of the request. Additionally, the API is protected by other security measures to safeguard user data.

To access your access token, follow these steps:

  1. Log in to the ToolzzAI platform
  2. Click on “Settings”
  3. Click on “Access Token”
  4. Copy the access token

Access token page