---
title: "Send Individual HSM"
method: POST
path: "/v2/whatsapp/{botId}/hsm"
tags: ["Campaigns"]
---

# Send Individual HSM

`POST /v2/whatsapp/{botId}/hsm`

## Request

- Base URL: `https://api.jelou.ai`
- URL: `https://api.jelou.ai/v2/whatsapp/{botId}/hsm`
- Auth: HTTP basic
- TypeScript: <https://skmtc.dev/jelou/apis/jelou-api/docs/v2/whatsapp/:botId/hsm/post.ts> (a function with typed inputs; its response is checked against the schema)

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

## Path parameters

- `botId` string, required

## Request body

- HSMRequest
  - `mediaUrl` string, uri: Public URL for media (required for image/video/document templates)
  - `filename` string: Filename for document templates
  - `type` 'text' | 'hsm' | 'image' | 'document' | 'video' | 'catalog' | 'carousel'
  - `language` 'en' | 'es' | 'pt'
  - `elementName` string, required: Approved template name
  - `parameters` string[]: Template parameter values
  - `destinations` string[], required: Phone numbers with country code, no + sign
  - `buttonPayloads` object[]
  - `actions` object
  - `headerParameters` string[]
  - `buttonParameters` ButtonParameter[]
    - `type` 'URL' | 'QUICK_REPLY' | 'CATALOG' | 'COPY_CODE'
    - `payload` object
    - `param` integer
  - `ltoParams` LTOParams
    - `expirationTime` integer: Expiration timestamp in milliseconds
  - `cards` CarouselCard[]
    - `mediaUrl` string, uri
    - `params` string[]
    - `buttonParameters` ButtonParameter[]
      - `type` 'URL' | 'QUICK_REPLY' | 'CATALOG' | 'COPY_CODE'
      - `payload` object
      - `param` integer
  - `expirationTime` string: Expiration timestamp in milliseconds
  - `campaignId` string

## Response `200`

HSM sent successfully

- object[]
  - `id` string
  - `destination` string

## Other responses

- `400`: Bad request - Invalid format or missing required fields
- `401`: Unauthorized - Invalid authentication credentials
- `404`: Not found - Resource not found
- `422`: Unprocessable entity - Validation error

---

[API](https://skmtc.dev/jelou/apis/jelou-api.md) - [All operations](https://skmtc.dev/jelou/apis/jelou-api/llms.txt) - [OpenAPI document](https://skmtc.dev/jelou/apis/jelou-api/revisions/845ce127d94a?raw)