API Reference
Log InRequest Live Demo
  1. CommPeak TextPeak API
  2. Streams

Add stream

post
https://api.commpeak.com/textpeak/streams

Create a new stream. name is required; other fields are optional and depend on the stream type (default MARKETING).

Lifecycle. SMS streams (MARKETING, TRANSACTIONAL, OTP, TWO_WAY) are active (READY) as soon as they are created. Every other type is created as a DRAFT: configure it with params, then activate it with a PUT that sets state to READY and sends no params.

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

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
length ≤ 255

Stream name. Must not be blank.

length ≤ 255

Free-text description.

enum

Stream type, case-insensitive. SMS types (MARKETING, TRANSACTIONAL, OTP, TWO_WAY) are active as soon as they are created; every other type is created as a DRAFT to configure.

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).

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.

enum

Requested state. Unknown values are ignored. RESTRICTED is set by CommPeak only.

Responses

Updated 20 days ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 20 days ago

Did this page help you?