Sign in

v1

latestOpenAPI 3.1.02026-07-26327152.4 KB
Campaigns

Send Individual HSM

Send a WhatsApp HSM template message to one or more recipients. Supports text, image, video, document, catalog, and carousel templates.

post/v2/whatsapp/{botId}/hsm

Path parameters

botIdstring required

The unique identifier of the bot

Request body

mediaUrlstring uri

Public URL for media (required for image/video/document templates)

filenamestring

Filename for document templates

type'text' | 'hsm' | 'image' | 'document' | 'video' | 'catalog' | 'carousel'
language'en' | 'es' | 'pt'
elementNamestring required

Approved template name

parametersstring[]

Template parameter values

destinationsstring[] required

Phone numbers with country code, no + sign

buttonPayloadsobject[]
actionsobject
headerParametersstring[]
expirationTimestring

Expiration timestamp in milliseconds

campaignIdstring

Response

HSM sent successfully

idstring
destinationstring