infoOverview
About this API
This API is used to upload the media on your
keySecurity
Authentication
Include your API credential in the request header. Keep credentials on the server and never expose them in client-side applications.
Locationheader
Field name
apikeyExample value
YOUR_WABA_API_KEYrouteParameters
Path Parameters
Substitute these placeholders in the endpoint URL before sending the request.
NameTypeRequirementDescription
phone_number_idstringRequiredResource identifier for phone number id.uploadInput
Request Body
Send a multipart/form-data payload. Replace placeholder values with data from your integration.
Top-Level Fields
NameTypeRequirementDescription
sheetstringRequiredRequest value for sheet.{
"sheet": "<MEDIA_FILE_TO_BE_UPLOADED>"
}{
"type": "object",
"required": [
"sheet"
],
"properties": {
"sheet": {
"type": "string",
"format": "binary"
}
}
}codeIntegration
Code Examples
Select your language and customize the request URL. Credential placeholders are intentionally preserved so secrets never appear in generated samples.
shield_lockCredentials protectedAdd secrets only in your secure server environment.
curl --request POST 'https://partnersv1.pinbot.ai/v3/{phone_number_id}/media' \
--header 'apikey: <API_KEY>' \
--form 'sheet=@/path/to/sheet'const form = new FormData();
form.append('sheet', fileInput.files[0]);
const response = await fetch('https://partnersv1.pinbot.ai/v3/{phone_number_id}/media', {
method: 'POST',
headers: {
"apikey": "<API_KEY>"
},
body: form,
});
if (!response.ok) throw new Error(`HTTP ${response.status}`);
const data = await response.json();
console.log(data);import { openAsBlob } from 'node:fs';
const form = new FormData();
form.append('sheet', await openAsBlob('/path/to/sheet'));
const response = await fetch('https://partnersv1.pinbot.ai/v3/{phone_number_id}/media', {
method: 'POST',
headers: {
"apikey": "<API_KEY>"
},
body: form,
});
if (!response.ok) throw new Error(`HTTP ${response.status}`);
const data = await response.json();
console.log(data);import json
import requests
url = 'https://partnersv1.pinbot.ai/v3/{phone_number_id}/media'
headers = {
"apikey": "<API_KEY>"
}
data = json.loads(r'''{}''')
with open('/path/to/sheet', 'rb') as media:
response = requests.post(url, headers=headers, data=data, files={'sheet': media})
response.raise_for_status()
print(response.json())import java.io.ByteArrayOutputStream;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.nio.charset.StandardCharsets;
import java.nio.file.Files;
import java.nio.file.Path;
String boundary = "----ApiDocsBoundary" + System.currentTimeMillis();
var body = new ByteArrayOutputStream();
body.write(("--" + boundary + "\r\n").getBytes(StandardCharsets.UTF_8));
body.write("Content-Disposition: form-data; name=\"sheet\"; filename=\"sheet\"\r\n".getBytes(StandardCharsets.UTF_8));
body.write("Content-Type: application/octet-stream\r\n\r\n".getBytes(StandardCharsets.UTF_8));
body.write(Files.readAllBytes(Path.of("/path/to/sheet")));
body.write("\r\n".getBytes(StandardCharsets.UTF_8));
body.write(("--" + boundary + "--\r\n").getBytes(StandardCharsets.UTF_8));
var requestBuilder = HttpRequest.newBuilder(URI.create("https://partnersv1.pinbot.ai/v3/{phone_number_id}/media"))
.header("Content-Type", "multipart/form-data; boundary=" + boundary)
.header("apikey", "<API_KEY>")
.method("POST", HttpRequest.BodyPublishers.ofByteArray(body.toByteArray()));
var response = HttpClient.newHttpClient().send(requestBuilder.build(), HttpResponse.BodyHandlers.ofString());
System.out.println(response.statusCode());
System.out.println(response.body());<?php
$curl = curl_init();
$fields = [
'sheet' => new CURLFile('/path/to/sheet'),
];
curl_setopt_array($curl, [
CURLOPT_URL => 'https://partnersv1.pinbot.ai/v3/{phone_number_id}/media',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_HTTPHEADER => ["apikey: <API_KEY>"],
CURLOPT_POSTFIELDS => $fields,
]);
$response = curl_exec($curl);
if ($response === false) throw new Exception(curl_error($curl));
curl_close($curl);
echo $response;using System.Net.Http.Headers;
using System.Text;
using var client = new HttpClient();
client.DefaultRequestHeaders.Add("apikey", "<API_KEY>");
using var form = new MultipartFormDataContent();
form.Add(new StreamContent(File.OpenRead(@"/path/to/sheet")), "sheet", "sheet");
var response = await client.PostAsync("https://partnersv1.pinbot.ai/v3/{phone_number_id}/media", form);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());package main
import (
"fmt"
"io"
"net/http"
"bytes"
"mime/multipart"
"os"
"path/filepath"
)
func main() {
var body bytes.Buffer
writer := multipart.NewWriter(&body)
file, err := os.Open("/path/to/sheet")
if err != nil { panic(err) }
defer file.Close()
part, err := writer.CreateFormFile("sheet", filepath.Base(file.Name()))
if err != nil { panic(err) }
if _, err = io.Copy(part, file); err != nil { panic(err) }
if err := writer.Close(); err != nil { panic(err) }
request, err := http.NewRequest("POST", "https://partnersv1.pinbot.ai/v3/{phone_number_id}/media", &body)
if err != nil { panic(err) }
request.Header.Set("Content-Type", writer.FormDataContentType())
request.Header.Set("Accept", "application/json")
request.Header.Set("apikey", "<API_KEY>")
response, err := http.DefaultClient.Do(request)
if err != nil { panic(err) }
defer response.Body.Close()
data, err := io.ReadAll(response.Body)
if err != nil { panic(err) }
if response.StatusCode >= 400 { panic(fmt.Sprintf("HTTP %d: %s", response.StatusCode, data)) }
fmt.Println(string(data))
}downloadOutput
Response
A successful request returns the documented response payload. Delivery and asynchronous events may arrive separately through configured webhooks.
{
"200": {
"response": {
"id": "{{mediaid}}"
}
}
}{
"type": "object",
"properties": {
"response": {
"type": "object",
"properties": {
"id": {
"type": "string"
}
}
}
}
}ruleHTTP Responses
Status Codes
200The request was successful.400Bad request or invalid parameters.401API key is missing or invalid.403The request is not authorized for this resource.404The requested resource was not found.500The server encountered an error.