delete
https://gw.commpeak.com/textpeak/streams/
Description
Summary: Permanently deletes a stream by its unique identifier. Details: This endpoint removes the specified stream and all of its associated configuration. Once deleted, the stream can no longer be used for sending or receiving messages. This action is irreversible — ensure the stream is no longer needed before calling this endpoint.
Authentication & Scopes
Authentication is handled via an API key provided in the Authorization header. No OAuth scopes are defined; access is granted or denied based on the validity of the key.
| Method | Details |
|---|---|
| API Key | Pass your API key directly in the Authorization header value (not as a Bearer token). |
Headers
| Header | Required | Description |
|---|---|---|
Authorization | Yes | The API key that verifies your access to the API. |
accept | No | Expected response format. Default: */*. |
Parameters
| Parameter | Type | Location | Required | Description |
|---|---|---|---|---|
id | number | Path | Yes | The unique identifier of the stream to delete. In the URL pattern /streams/{id}, replace {id} with the stream ID. |
Request Body
This endpoint does not use a request body.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…