You can use the WhatsApp Template Management API to upload files when your template components need a media handle for an image, video, or document header. You can use this API version if you authenticate requests with an Insider One API key.
All examples below use sample data and payloads for documentation purposes only. Before going live, replace all template names, languages, components, and media handles with values specific to your own integration.
For the V1 template API, authenticate requests with
x-ins-auth-key. Public examples below use the Gateway base URL so that your integration stays on a public entrypoint instead of calling internal services.
For this endpoint, only image, video, and document file types are supported.
Endpoint and Headers
POST https://whatsapp.useinsider.com/api/v1/templates/file-upload
Headers
Header | Sample Value | Description |
|---|---|---|
X-INS-AUTH-KEY | 1a2b3c4d5e6f | This key is required to authorize your request. Refer to Generate API Credentials for WhatsApp Template Management to generate your token. |
Content-Type | application/json | This header specifies the media type of the resource. |
Body Parameters
Column | Data Type | Required | Description |
|---|---|---|---|
name | String | Yes | The template name to create. |
language | String | Yes | The template locale, such as |
category | String | Yes | The Meta template category. |
components | Array[object] | Yes | At least one component is required. |
Sample Request
curl --location 'https://whatsapp.useinsider.com/api/v1/templates/file-upload' \
--header 'x-ins-auth-key: your-api-key' \
--form 'file=@"/path/to/header-image.png"'Sample Response
A successful request returns the following JSON response.
{
"id": "4::aW1hZ2UvcG5n:ARbExampleMediaHandle"
}