Skip to main content
DELETE
/
api
/
chatwoot
/
delete
/
:instance
Deactivate integration
curl --request DELETE \
  --url https://api.example.com/api/chatwoot/delete/:instance \
  --header 'token: <token>'

Documentation Index

Fetch the complete documentation index at: https://docs.ryzeapi.cloud/llms.txt

Use this file to discover all available pages before exploring further.

Auth: TokenAccount or TokenInstance • Rate limit: Global (100/min) • Idempotent: yes

​
Description

Deactivates the Chatwoot integration for the instance. The server asks the RyzeIntegrations bridge to terminate the integration (closes the internal WebSocket, releases resources), deletes the corresponding inbox in Chatwoot, and removes the local row.
The inbox created in Chatwoot is deleted along with the integration. Conversations linked to that inbox may be lost, if you want to preserve history, export it before calling this endpoint.

​
Example

curl -X DELETE "https://ryzeapi.cloud/api/chatwoot/delete/suporte" \
  -H "token: $Token_Account"

​
Success response

200 OK
{
  "message": "chatwoot integration deactivated"
}

​
Path parameters

​
instance
string
required
Instance name (e.g., suporte).

​
Headers

​
token
string
required
TokenAccount or TokenInstance.

​
Behavior

1

Look up the local integration

Reads the bridge_integration_id from the chatwoot_integrations table. If it doesn’t exist, returns 404.
2

DELETE on the bridge (30s timeout)

If the bridge is enabled, calls DELETE /v1/integrations/<bridge_integration_id>. The bridge closes the WebSocket and deletes the inbox in Chatwoot (DELETE /api/v1/accounts/<id>/inboxes/<inbox_id>).
  • Bridge 404 → treated as already removed (does not fail).
  • Other errors → log a warning on the server and proceed to the next step.
3

Remove the local row

Deletes the record from chatwoot_integrations in RyzeAPI. The operation is considered successful when this step completes.
Removal of the inbox in Chatwoot is permanent. To reactivate the integration later, use POST /api/chatwoot/set/:instance, a new inbox will be created.

​
Errors

HTTPerror.message
404instance not found
404no chatwoot integration to delete
503integration gateway not configured (set BRIDGE_URL and BRIDGE_TOKEN)

​
Next

Reactivate

Recreate the integration with POST /api/chatwoot/set/:instance.

Overview

Go back to the module’s architecture and environment variables.