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

# POST /api/admin/content/templates/test

`POST /api/admin/content/templates/test`

Send a test message for a message template.

## Request body

- union
  - object
    - `workspaceId` string, required
    - `templateId` string, required
    - `userProperties` object, required
    - `tags` object
    - `channel` 'Email', required
    - `provider` union
      - 'SendGrid'
      - 'AmazonSes'
      - 'Resend'
      - 'PostMark'
      - 'Smtp'
      - 'Test'
      - 'MailChimp'
      - 'Gmail'
  - object
    - `workspaceId` string, required
    - `templateId` string, required
    - `userProperties` object, required
    - `tags` object
    - `channel` 'Sms', required
    - `provider` union
      - 'Twilio'
      - 'SignalWire'
      - 'Test'
  - object
    - `workspaceId` string, required
    - `templateId` string, required
    - `userProperties` object, required
    - `tags` object
    - `channel` 'MobilePush', required
    - `provider` union
      - 'Firebase'
      - 'Test'
  - object
    - `workspaceId` string, required
    - `templateId` string, required
    - `userProperties` object, required
    - `tags` object
    - `channel` 'Webhook', required
    - `provider` unknown

## Response `200`

Default Response

- union
  - object
    - `type` 'Ok', required
    - `value` union, required
      - object
        - `type` 'DFInternalMessageSent', required
        - `variant` union, required
          - object
            - `type` 'Email', required
            - `provider` union, required
              - …
            - `to` string, required
            - `headers` object
            - `attachments` object[]
              - …
            - `from` string, required
            - `subject` string, required
            - `replyTo` string
            - `cc` string
            - `bcc` string
            - `name` string
            - `attachmentUserProperties` string[] — Names of user properties to attach to the email as attachments.
            - `emailContentsType` 'Code'
            - `body` string, required
          - object
            - `type` 'Sms', required
            - `provider` union, required
              - …
            - `to` string, required
            - `body` string, required
          - object
            - `type` 'Webhook', required
            - `to` string, required
            - `request` object, required
              - …
            - `response` object, required
              - …
      - object
        - `type` 'DFMessageSkipped', required
        - `message` string
  - object
    - `type` 'Err', required
    - `err` object, required
      - `suggestions` string[], required
      - `responseData` string

---

[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)