---
title: "Start Batch Session"
method: POST
path: "/api/outreach/batch"
tags: ["outreach", "outreach"]
---

# Start Batch Session

`POST /api/outreach/batch`

## 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/batch`
- Auth: none declared

Start a batch outreach session.
Creates session and items, then processes in background.

## Request body

- BatchSendRequest: Request to start batch outreach session.
  - `person_ids` integer[], required
  - `message_type` 'llm' | 'template'
  - `template_text` string, nullable
  - `prompt_source` 'state' | 'custom' | 'adhoc'
  - `prompt_id` integer, nullable
  - `state` string, nullable
  - `adhoc_prompt` string, nullable
  - `model` string
  - `temperature` number, nullable
  - `as_draft` boolean
  - `attachment_file_ids` integer[]
  - `include_sendable_files` boolean

## Response `200`

Successful Response

- BatchSessionResponse: Response for batch session creation.
  - `session` BatchSession, required: Batch outreach session.
    - `id` integer, required
    - `prompt_source` string, required
    - `prompt_id` integer, nullable
    - `state_used` string, nullable
    - `model` string, required
    - `as_draft` boolean, required
    - `total_contacts` integer, required
    - `sent_count` integer, required
    - `error_count` integer, required
    - `status` string, required
    - `started_at` string, nullable
    - `completed_at` string, nullable
    - `created_at` string, required
    - `items` BatchSessionItem[], nullable
      - `id` integer, required
      - `person_id` integer, required
      - `person_name` string, nullable
      - `status` string, required
      - `message_text` string, nullable
      - `draft_id` integer, nullable
      - `error_message` 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/77bef09a9209?raw)