Description
Summary: Updates an existing stream event template by its ID via the TextPeak API.
Details: This endpoint modifies the properties of a specific stream event template identified by its unique ID. You can update any combination of the template's name, associated stream, message text, event key, and activation status. This is useful for correcting template content, reassigning a template to a different stream, changing the trigger key, or enabling/disabling a template without deleting and recreating it. The request body should contain the full updated representation of the template. Authentication is performed via a TextPeak API key passed in the Authorization header.
Authentication & Scopes
Authentication is handled via a TextPeak API key provided in the Authorization header. No OAuth scopes are defined; access is granted or denied based on the validity of the API key.
| Method | Details |
|---|---|
| API Key | Pass your TextPeak API key directly in the Authorization header value. |
Headers
| Header | Required | Description |
|---|---|---|
Authorization | Yes | Your TextPeak API key that authenticates the request. |
Content-Type | Yes | Must be set to application/json. The API only accepts JSON-formatted request bodies. |
accept | Yes | Must be set to application/json. Indicates that the client expects a JSON response. |
Parameters
Path Variables
| Variable | Type | Required | Description |
|---|---|---|---|
id | string | Yes | The unique identifier of the stream event template to update. |
Request Body
The request body is a JSON object containing the updated fields for the stream event template.
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | The updated human-readable name for the stream event template. |
streamId | integer | Yes | The numeric ID of the stream this event template belongs to. Change this to reassign the template to a different stream. |
text | string | Yes | The updated message text content of the template. |
eventKey | string | Yes | The updated unique key used to identify and trigger this event template programmatically. |
activated | boolean | Yes | Whether the template should be active (true) or disabled (false). |
Examples
This endpoint has a saved example demonstrating usage:
- Update stream event template — Updating the properties of an existing stream event template by its ID.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||