put
https://gw.commpeak.com/textpeak/streams/
Description
Summary: Updates the configuration of an existing stream. Details: This endpoint allows you to modify one or more properties of a stream identified by its unique ID. You can update the stream's name, description, type, IP access control list (ACL), and state. Only the fields included in the request body will be updated; omitted fields remain unchanged.
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. |
Content-Type | Yes | Must be set to application/json. The API only accepts JSON-formatted request bodies. |
accept | No | Expected response format. Default: application/json. |
Parameters
| Parameter | Type | Location | Required | Description |
|---|---|---|---|---|
id | number | Path | Yes | The unique identifier of the stream to update. In the URL pattern /streams/{id}, replace {id} with the stream ID. |
Request Body
The request body is a JSON object. All fields are optional — include only the fields you wish to update.
| Field | Type | Required | Description |
|---|---|---|---|
name | string | No | The display name of the stream. |
description | string | No | A human-readable description of the stream's purpose. |
type | string | No | The type/category of the stream (e.g., SMS, voice, etc.). |
ipAcl | string | No | An IP-based access control list that restricts which IPs can interact with this stream. |
state | string | No | The operational state of the stream (e.g., active, inactive). |
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…