Skip to the page
BlueBot

API reference

Delete a keyword rule

The rule stops matching at once.

Open in Claude Open in ChatGPT .md
DELETE/v1/automations/rules/{id}

The rule stops matching at once.

Needs a key with the messages:send scope. Keys and scopes

Path parameters

  • idstringrequired

    The rule’s id.

    Starts with kw_.

Example

DELETE/v1/automations/rules/kw_1Hq2LxW9cVbN3mKpRtYs0aDelete a keyword rule →
curl -X DELETE "https://usebluebot.com/api/v1/automations/rules/kw_1Hq2LxW9cVbN3mKpRtYs0a" \
  -H "Authorization: Bearer $BLUEBOT_API_KEY"

Response

200: It is gone.

  • idstringrequired
  • object"keyword_rule"required
  • deletedtruerequired
Response200
{
  "id": "kw_1Hq2LxW9cVbN3mKpRtYs0a",
  "object": "keyword_rule",
  "deleted": true
}

Errors

Every refusal has the same envelope and a page of its own. These are the ones this operation can give.

CodeStatusWhat it means
unauthorized401The request carried no key, or a key BlueBot doesn’t know: mistyped, revoked, or a test key sent to the live API.
insufficient_scope403The key doesn’t carry the scope the endpoint needs. Each endpoint’s reference names its scope.
rate_limited429Too many requests. A key may make 120 requests a minute. The RateLimit header says how many are left, and Retry-After how long to wait.
internal500Something went wrong on BlueBot’s side. It was reported. Send the request again; with an Idempotency-Key that is always safe.
not_found404There is no such thing on this account. Ids are prefixed by kind, so a message id starts with msg_.

Try it

Call this operation from the page with your own key. The key stays in this tab and is forgotten when you leave.