---
title: "POST /api/admin/content/templates/batch-send"
method: POST
path: "/api/admin/content/templates/batch-send"
tags: ["Content"]
---

# POST /api/admin/content/templates/batch-send

`POST /api/admin/content/templates/batch-send`

Send messages to a batch of users using a message template.

## Request body

- union
  - object
    - `workspaceId` string, required
    - `templateId` string, required
    - `subscriptionGroupId` string
    - `users` object[], required
      - `id` string, required
      - `messageId` string — Message Id to set on the tracked event. If not provided, a message id will be generated.
      - `properties` object, required — User property values to be rendered in the message, keyed by name. Will override values present on the user.
      - `context` object — Context values for this specific user's events. Will override batch-level context values.
    - `context` object
    - `channel` 'Email', required
    - `provider` union
      - 'SendGrid'
      - 'AmazonSes'
      - 'Resend'
      - 'PostMark'
      - 'Smtp'
      - 'Test'
      - 'MailChimp'
      - 'Gmail'
  - object
    - `workspaceId` string, required
    - `templateId` string, required
    - `subscriptionGroupId` string
    - `users` object[], required
      - `id` string, required
      - `messageId` string — Message Id to set on the tracked event. If not provided, a message id will be generated.
      - `properties` object, required — User property values to be rendered in the message, keyed by name. Will override values present on the user.
      - `context` object — Context values for this specific user's events. Will override batch-level context values.
    - `context` object
    - `channel` 'Sms', required
    - `provider` union
      - 'Twilio'
      - 'SignalWire'
      - 'Test'
  - object
    - `workspaceId` string, required
    - `templateId` string, required
    - `subscriptionGroupId` string
    - `users` object[], required
      - `id` string, required
      - `messageId` string — Message Id to set on the tracked event. If not provided, a message id will be generated.
      - `properties` object, required — User property values to be rendered in the message, keyed by name. Will override values present on the user.
      - `context` object — Context values for this specific user's events. Will override batch-level context values.
    - `context` object
    - `channel` 'Webhook', required
    - `provider` unknown

## Response `200`

Default Response

- object
  - `results` union[], required
    - union
      - object
        - `userId` string, required
        - `type` 'Success', required
        - `messageId` string, required
      - object
        - `userId` string, required
        - `type` 'Skipped', required
        - `reason` string, required
        - `messageId` string, required
      - object
        - `userId` string, required
        - `type` 'RetryableError', required
        - `messageId` string, required
        - `error` object, required
          - `message` string, required
      - object
        - `userId` string, required
        - `type` 'NonRetryableError', required
        - `messageId` string, required
        - `error` union, required
          - object
            - `type` 'DFBadWorkspaceConfiguration', required
            - `variant` union, required
              - …
          - object
            - `type` 'DFMessageFailure', required
            - `variant` union, required
              - …

## Other responses

- `500` — Default Response

---

[API](https://skmtc.net/dittofeed/apis/dittofeed-api.md) · [All operations](https://skmtc.net/dittofeed/apis/dittofeed-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/dittofeed/dittofeed-api/revisions/13cf71747bf1/schema)