Remover bot

DELETE

api

typebot

delete

:instance

Remover bot

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

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

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

Auth: TokenAccount ou TokenInstance • Rate-limit: Global (100/min) • Idempotente: sim

Descrição

Remove bots do Typebot da instância e re-sincroniza a integração:

Com ?botId=, apaga um bot específico e re-sincroniza os restantes.
Sem botId, apaga todos os bots da instância e desconecta a integração (o vínculo local é removido e a integração é desativada).

Quando o último bot é removido (seja pelo delete-all, seja apagando o único bot restante), a integração é desativada e o vínculo local é apagado.

Chamar este endpoint sem botId apaga todos os bots da instância de uma vez. Use com cuidado, a operação não é reversível.

A re-sincronização da integração é best-effort: se ela falhar, o servidor apenas registra um warning e a remoção continua válida (as linhas locais já foram apagadas). Por isso este endpoint não expõe erros de sincronização no retorno.

Exemplo

Remover um bot (?botId=):

curl -X DELETE "https://ryzeapi.cloud/api/typebot/delete/suporte?botId=8f3a1c2e-...-b7d9" \
  -H "token: $Token_Account"

await fetch("https://ryzeapi.cloud/api/typebot/delete/suporte?botId=8f3a1c2e-...-b7d9", {
  method: "DELETE",
  headers: {
    "token": process.env.Token_Account
  }
});

import os, requests

requests.delete(
    "https://ryzeapi.cloud/api/typebot/delete/suporte",
    params={"botId": "8f3a1c2e-...-b7d9"},
    headers={"token": os.environ["Token_Account"]}
)

package main

import (
    "net/http"
    "os"
)

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

Remover todos os bots:

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

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

import os, requests

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

package main

import (
    "net/http"
    "os"
)

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

Resposta de sucesso

200 OK

{
  "success": true,
  "message": "typebot bot(s) deleted",
  "meta": {
    "deleted": 1
  }
}

Campo	Descrição
`success`	`true` em caso de sucesso.
`message`	Mensagem fixa de confirmação (`typebot bot(s) deleted`).
`meta.deleted`	Quantos bots foram removidos (`1` com `?botId=`; N no delete-all).

Parâmetros de rota

string

obrigatório

Nome da instância (ex.: suporte).

Query params

string

UUID do bot a remover, obtido em GET /api/typebot/list/:instance. Omitido, apaga todos os bots da instância e desconecta a integração.

Headers

string

obrigatório

TokenAccount ou TokenInstance.

Comportamento

Remove os bots locais

Com ?botId=, apaga a linha correspondente da tabela typebot_bots (se não existir, devolve 404). Sem botId, apaga todas as linhas de bots da instância.

Re-sincroniza os bots restantes (timeout 60s)

A RyzeAPI recomputa a lista de bots e (re)ativa a integração. Falha aqui é apenas logada como warning, não reverte a remoção.

Desativa se não sobrou nenhum

Quando não resta nenhum bot (delete-all, ou remoção do último), a integração é desativada e o vínculo em typebot_integrations é apagado.

Erros

HTTP	`error.message`	Causa
404	`instance not found`	Instância não existe na RyzeAPI.
404	`bot not found for this instance`	`?botId=` informado não existe nesta instância.

Listar bots

Confira quais bots ainda estão cadastrados na instância.

Cadastrar bot

Recrie ou adicione um bot com POST /api/typebot/set/:instance.

Introdução

Instância

Eventos

Mensagens

Chamadas

Grupos

Comunidades

Newsletter

Perfil

Chat

Chatwoot

Typebot

Observabilidade

Descrição

Exemplo

Resposta de sucesso

Parâmetros de rota

Query params

Headers

Comportamento

Erros

Próximo

Listar bots

Cadastrar bot

​Descrição

​Exemplo

​Resposta de sucesso

​Parâmetros de rota

​Query params

​Headers

​Comportamento

​Erros

​Próximo

Listar bots

Cadastrar bot

Descrição

Exemplo

Resposta de sucesso

Parâmetros de rota

Query params

Headers

Comportamento

Erros

Próximo