Update Credential

Endpoint used to update a credential.

Request Example

curl --request PUT \
  --url https://chat.api.toolzz.com.br/api/v1/credential/{id} \
  --header 'Authorization: Bearer TOKEN_HERE' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "userId": "<string>",
  "unityId": "<string>",
  "integrationId": "<string>",
  "secretId": "<string>",
  "status": true
}
'

Response Example

{
  "message": "<string>",
  "id": "<string>",
  "name": "<string>",
  "userId": "<string>",
  "unityId": "<string>",
  "integrationId": "<string>",
  "secretId": "<string>",
  "status": true,
  "virtualKey": "<string>",
  "credentials": {},
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "integration": {
    "id": "<string>",
    "name": "<string>",
    "iconId": "<string>",
    "type": "<string>",
    "status": true,
    "validationEndpoint": "<string>",
    "slug": "<string>",
    "form": [
      {
        "name": "<string>",
        "type": "<string>",
        "label": "<string>",
        "maxLenght": 123,
        "required": true
      }
    ],
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "icon": {
      "id": "<string>",
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "institutionId": "<string>",
      "type": "<string>",
      "fileName": "<string>",
      "internalStorageUrl": "<string>",
      "url": "<string>",
      "size": 123,
      "extension": "<string>",
      "maskName": "<string>"
    }
  }
}

---

Request description

Access Token

Parameter	Type	Description	Required
Authorization	String	Access token (“Bearer” must be before the token)	Yes

URL Parameters (Path)

Parameter	Type	Description	Required
id	UUID	Credential unique identifier.	Yes

Body Parameters

Parameter	Type	Description	Required
name	String	New identification name for the credential.	Yes
userId	UUID	Owning user’s unique identifier.	Yes
unityId	UUID	Linked organizational unit identifier.	Yes
integrationId	UUID	Service provider identifier (OpenAI, Gemini, etc.).	Yes
secretId	UUID	Technical secret identifier stored in the vault.	No
status	Boolean	Defines if the credential should be active (true) or inactive (false).	Yes

---

Response description

Key	Type	Description
message	String	Confirmation message (e.g., “Credential updated successfully”).
id	UUID	Unique identifier of the updated credential.
name	String	Updated credential name.
userId	UUID	Linked user ID.
unityId	UUID	Linked organizational unit ID.
integrationId	UUID	Integration provider ID.
status	Boolean	Current activation status of the credential.
virtualKey	String	Internal identification virtual key.
credentials	Object	Technical keys object (usually empty for security in the response).
updatedAt	String	Last modification date and time (ISO 8601).
integration	Object	Object containing the service provider details.
integration.name	String	Provider name (e.g., “Open AI”).
integration.type	String	Integration category (e.g., llm, voice).
integration.form	Array	List of configuration fields required by the provider.
integration.icon	Object	Provider icon file metadata.
integration.icon.url	URL	Direct link to the provider’s logo image.
integration.icon.extension	String	Image file extension (e.g., png).

---

Security

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