---
title: "Preview Schedule Message"
method: POST
path: "/api/outreach/schedules/preview"
tags: ["outreach", "outreach"]
---

# Preview Schedule Message

`POST /api/outreach/schedules/preview`

## Request

- Base URL: `https://api.dialogbrain.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.dialogbrain.com/api/outreach/schedules/preview`
- Auth: none declared

Preview a schedule message without creating a schedule.

## Request body

- PreviewScheduleMessageRequest: Request to preview a schedule message.
  - `person_id` integer, required
  - `message_type` 'llm' | 'template', required
  - `prompt_source` 'state' | 'custom' | 'adhoc', nullable
  - `prompt_id` integer, nullable
  - `prompt_state` string, nullable
  - `llm_prompt` string, nullable
  - `llm_model` string, nullable
  - `template_text` string, nullable
  - `template_variables` object

## Response `200`

Successful Response

- PreviewScheduleMessageResponse: Preview result.
  - `success` boolean, required
  - `message` string, nullable
  - `variables_resolved` object
  - `error` string, nullable

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/dialogbrain/apis/dialogbrain-v2-api-gateway.md) · [All operations](https://skmtc.dev/dialogbrain/apis/dialogbrain-v2-api-gateway/llms.txt) · [OpenAPI document](https://skmtc.dev/dialogbrain/apis/dialogbrain-v2-api-gateway/revisions/d84e7dc9977d?raw)
