Update Toolzz Chat Integration

Endpoint to update Toolzz Chat integration with the agent.

Request Example

curl --request POST \
  --url https://converflow.api.prod.toolzz.media/api/v1/chat/integration/{integrationId} \
  --header 'Authorization: Bearer TOKEN_HERE' \
  --header 'Content-Type: application/json' \
  --data '
{
    "unitId": "uuid",
    "title": "string",
    "teamId": 12345678,
    "infisicalReference": {
        "secretName": "uuid"
    },
    "inboxId": 123,
    "handoffAction": "string",
    "escalationNotice": "string",
    "keepHistory": true,
    "sendInitialMessage": true
}
'

Response Example

{
    "id": "uuid",
    "title": "<string>",
    "isActive": true,
    "unitId": "uuid",
    "credentialId": "uuid",
    "accountId": 1,
    "inboxId": 0,
    "teamId": 0,
    "handoffAction": "<string>",
    "escalationNotice": "<string>",
    "keepHistory": false,
    "sendInitialMessage": true
}

Request description

Access Token

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

Body Parameters

Key	Type	Description	Required
unitId	UUID	Unique identifier of the organizational unit.	Yes
title	String	Identifier title of this transfer configuration.	Yes
teamId	Number	ID of the department/team (seen in the previous listing) where the chat will be moved.	Yes
infisicalReference	Object	Security reference for required API keys.	Yes
infisicalReference.secretName	String	ID or name of the secret in the Infisical vault (e.g., ToolzzChat credential).	Yes
inboxId	Number	ID of the specific inbox that will receive the conversation.	Yes
handoffAction	String	Prompt or command that triggers the transfer logic.	Yes
escalationNotice	String	Message sent to the end user informing about the transfer.	Yes
keepHistory	Boolean	If true, the conversation history with the AI will be maintained for the human attendant.	Yes
sendInitialMessage	Boolean	Defines if an automatic initial message should be triggered after handoff.	Yes

Response description

Key	Type	Description
id	UUID	Unique identifier of the handoff configuration in the database.
title	String	Identifier title of the configuration (e.g., “test of test”).
isActive	Boolean	Indicates if this transfer rule is active.
unitId	UUID	Unique identifier of the owning organizational unit.
credentialId	UUID	Linked Toolzz Chat credential ID (retrieved from the vault).
accountId	Number	Account ID in the human service provider.
inboxId	Number	ID of the inbox that will receive the ticket.
teamId	Number	ID of the target team/department (e.g., 4 - CS).
handoffAction	String	The instruction or trigger that the AI follows to transfer.
escalationNotice	String	Feedback message sent to the user at the moment of transfer.
keepHistory	Boolean	Defines if the conversation history with the AI will be hidden or maintained.
sendInitialMessage	Boolean	Defines if the system triggers an automatic message when entering the human queue.

---

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