Deactivate integration

DELETE

api

chatwoot

delete

:instance

Deactivate integration

curl --request DELETE \
  --url https://api.example.com/api/chatwoot/delete/:instance \
  --header 'token: <token>'

const options = {method: 'DELETE', headers: {token: '<token>'}};

fetch('https://api.example.com/api/chatwoot/delete/:instance', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

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"

await fetch("https://ryzeapi.cloud/api/chatwoot/delete/suporte", {
  method: "DELETE",
  headers: {
    "token": process.env.Token_Account
  }
});

import os, requests

requests.delete(
    "https://ryzeapi.cloud/api/chatwoot/delete/suporte",
    headers={
        "token": os.environ["Token_Account"]
    }
)

package main

import (
    "net/http"
    "os"
)

func main() {
    req, _ := http.NewRequest("DELETE", "https://ryzeapi.cloud/api/chatwoot/delete/suporte", nil)
    req.Header.Set("token", os.Getenv("Token_Account"))
    http.DefaultClient.Do(req)
}

Success response

200 OK

{
  "message": "chatwoot integration deactivated"
}

Path parameters

string

required

Instance name (e.g., suporte).

Headers

string

required

TokenAccount or TokenInstance.

Behavior

Look up the local integration

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

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.

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

HTTP	`error.message`
404	`instance not found`
404	`no chatwoot integration to delete`
503	`integration gateway not configured`

Reactivate

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

Overview

Go back to the module overview.

Introduction

Instance

Events

Messages

Calls

Groups

Communities

Newsletter

Profile

Chat

Chatwoot

Typebot

Observability

Deactivate integration

Description

Example

Success response

Path parameters

Headers

Behavior

Errors

Next

Reactivate

Overview

​Description

​Example

​Success response

​Path parameters

​Headers

​Behavior

​Errors

​Next

Reactivate

Overview

Description

Example

Success response

Path parameters

Headers

Behavior

Errors

Next