Update stream

put

https://api.commpeak.com/textpeak/streams/{id}

Update an existing stream. Only the fields you send are changed.

Activation. A request that carries params is a configuration step and never activates the stream. To activate a DRAFT stream, send state: "READY" without params; the configuration is validated first and a 400 explains what is missing.

Authentication: TextPeak API key in the Authorization header (see Authentication in the API Overview).

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

integer

required

Unique identifier of the resource.

Body Params

Only the fields you send are changed.

name

length ≤ 255

Stream name. Must not be blank when sent.

description

length ≤ 255

Free-text description.

type

enum

Stream type, case-insensitive.

params

object | null

Type-specific configuration. Keys outside the allow-list for the stream type are dropped. All types: check_ip_acl (0/1), enable_timezone_checks (0/1). MARKETING / TRANSACTIONAL / TWO_WAY: content_generator (0 none, 1 inline templates, 2 event templates). WHATSAPP_BUSINESS: auth_token, business_id, selected_sender_id. TELEGRAM_BOT: auth_token, bot_name. Sending params is a configuration step: it never activates the stream (see the stream lifecycle in the overview).

ipAcl

string | array | null

IP / CIDR allow-list restricting where this stream may be used. A comma-separated string or an array; values are trimmed and sorted. Spaces are not separators. Empty disables the check.

state

enum

Requested state. A request without params that sets READY on a stream that is not yet active is the activation step: the stream configuration is validated first. Requests to a RESTRICTED stream are refused.

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful Response

400The request could not be applied (invalid value or state).

401Missing or invalid API key.

403The API key is not allowed to use this endpoint.

404No item with this ID on your account.

422Validation failed (missing or invalid field).

500The request was rejected by the server (see the endpoint description).