API Explorer 935 endpoints

Delete Signal Channel

DELETE /obp/v7.0.0/signal-channels/CHANNEL_NAME

OBPv6.0.0-deleteSignalChannel Roles: CanDeleteSignalChannel AI-AgentSignal-Channel

Signal channels provide short-lived, Redis-backed messaging designed for AI agent discovery and coordination, but usable by any authenticated OBP consumer. Messages are ephemeral and will expire after the configured TTL (default 1 hour).

This endpoint deletes a signal channel and all its messages immediately — including other users' in-flight messages, which is why it requires the CanDeleteSignalChannel role rather than being open to every publisher. (Channels also expire on their own via the TTL.)

Authentication is Required.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

CHANNEL_NAME: CHANNEL_NAME

JSON response body fields (2)
channel_name
channel_name
deleted
deleted
Example success response
{
  "channel_name": "discovery",
  "deleted": true
}
Possible errors (4)
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-10057: Invalid Signal Channel name. Signal Channel names must use only alphanumeric characters, dots, hyphens, and underscores, and be between 1 and 128 characters long.
  • OBP-50000: Unknown Error.
Implemented by OBPv6.0.0 deleteSignalChannel Originally /obp/v6.0.0/signal-channels/CHANNEL_NAME