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>'
Auth: TokenAccount or TokenInstance • Rate limit: Global (100/min) • Idempotent: yes

​
Description

Deactivates the Chatwoot integration for the instance. RyzeAPI terminates the integration and removes the local row. The Chatwoot inbox is not deleted: it only loses its connection to the instance.
The Chatwoot inbox is not deleted: its conversations and messages are preserved. It only loses its connection to the instance. If you connect Chatwoot again later, a new inbox is created.

​
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 record from the chatwoot_integrations table. If it doesn’t exist, returns 404.
2

Terminate the integration (30s timeout)

RyzeAPI terminates the integration. The Chatwoot inbox is preserved (it loses its link to the instance but keeps its messages).
  • Already removed → treated as success (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.
The Chatwoot inbox is not removed: it only loses its connection to the instance. If you reactivate the integration later (POST /api/chatwoot/set/:instance), a new inbox is created.

​
Errors

HTTPerror.message
404instance not found
404no chatwoot integration to delete
503integration gateway not configured

​
Next

Reactivate

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

Overview

Go back to the module overview.