Description
Summary: Uploads a file and forwards it to a specific account via the TextPeak Streams API.
Details: This endpoint allows you to upload a file (such as an image, document, or media attachment) and forward it to a recipient identified by their account phone number. The file is sent as multipart form-data. This is typically used to send media content through a messaging stream — for example, forwarding an image or document to a WhatsApp or SMS conversation. Authentication is performed via a stream token passed in the Authorization header.
Authentication & Scopes
Authentication is handled via a stream token provided in the Authorization header. No OAuth scopes are defined; access is granted or denied based on the validity of the token.
| Method | Details |
|---|---|
| Stream Token | Pass your token directly in the Authorization header value (not as a Bearer token). |
Headers
| Header | Required | Description |
|---|---|---|
Authorization | Yes | The stream token that verifies your access to the API. |
Content-Type | Auto | Automatically set to multipart/form-data by Postman when a file is attached. Do not set manually. |
Parameters
Path Variables
| Variable | Required | Description |
|---|---|---|
:account_phone_number | Yes | The phone number of the target account the file will be forwarded to, in international format (e.g., "972507445456"). |
Request Body
The request body uses multipart/form-data encoding to transmit the file.
| Field | Type | Required | Description |
|---|---|---|---|
file | file | Yes | The file to upload and forward. Supported formats may include images, documents, and other media types depending on the messaging channel. |
Examples
This endpoint has a saved example demonstrating usage:
- Upload file — Uploading and forwarding a file to a specific account phone number.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||