Create stream event template

Create a reusable event template. name, streamId, text and eventKey are required; trigger it later by passing eventKey as event on the send endpoints.

On SMS streams, every [placeholder] in text becomes a template variable, filled from template_variables when you send.

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

Template name. Must not be blank.

integer
required

ID of the stream to attach this template to.

string
required

Template body with [placeholder] tokens. On SMS streams each placeholder becomes a template variable.

string
required

Key used to trigger this template on the send endpoints (event). Must not be blank.

Whether the template is active.

Responses

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