Sign in

v1

latestOpenAPI 3.0.32026-07-24156161.2 MB
Streams Service

Upload file

Upload a media file to use in WhatsApp sends. The response returns a media_id that you then pass to the Send Media endpoint. Send the file as multipart/form-data.

Authentication: stream token in the Authorization header (see Authentication in the API Overview).

post/streams/forward-upload/{account_phone_number}

Path parameters

account_phone_numberstring required

The WhatsApp Business account phone number the media is uploaded for, in international format (digits only).

Response

The file was uploaded.

status_codeinteger

HTTP status returned by the upstream upload service.

Example response

{
  "status_code": 200,
  "remote_response": {
    "status": true,
    "uploaded_media": [
      {
        "file_name": "receipt.pdf",
        "media_id": "01d1e10f-2b3c-4d5e-6f70-3707906010e2",
        "download_url": "https://gw.commpeak.com/conv_media/01d1e10f-2b3c-4d5e-6f70-3707906010e2"
      }
    ]
  }
}