---
title: "Create Outgoing Batch"
method: POST
path: "/v1/matters/{matter_id}/day-ones/outgoing-batches"
tags: ["day-ones"]
---

# Create Outgoing Batch

`POST /v1/matters/{matter_id}/day-ones/outgoing-batches`

## Request

- Base URL: `https://api.ender.au` (the document declares no server; this is the origin it was published from)
- URL: `https://api.ender.au/v1/matters/{matter_id}/day-ones/outgoing-batches`
- Auth: HTTP bearer

## Path parameters

- `matter_id` string, uuid, required

## Headers

- `Idempotency-Key` string, required

## Request body

- CreateOutgoingBatch
  - `expected_configuration_version` integer, required
  - `groups` OutgoingGroup[], required
    - `category` string, required
    - `recipient_mode` 'individual' | 'bcc', required
    - `subject` string, required
    - `body_html` string, required
    - `document_ids` string[], required
    - `to_recipients` OutgoingRecipient[]
      - `email` string, required
      - `name` string, nullable
      - `source_id` string, uuid, required
      - `source_kind` 'bankrupt' | 'creditor' | 'director' | 'employee' | 'manual' | 'organisation' | 'premises' | 'security', required
    - `bcc_recipients` OutgoingRecipient[]
      - `email` string, required
      - `name` string, nullable
      - `source_id` string, uuid, required
      - `source_kind` 'bankrupt' | 'creditor' | 'director' | 'employee' | 'manual' | 'organisation' | 'premises' | 'security', required

## Response `202`

Successful Response

- OutgoingBatchStart
  - `batch` OutgoingBatch, required
    - `id` string, uuid, required
    - `matter_id` string, uuid, required
    - `operation_id` string, uuid, nullable, required
    - `state` 'draft' | 'ready_for_review' | 'approved' | 'superseded', required
    - `version` integer, required
    - `created_at` string, date-time, required
    - `updated_at` string, date-time, required
    - `sender_user` DayOnesMailboxUser, required
      - `user_id` string, uuid, required
      - `name` string, required
      - `email` string, required
    - `can_open_in_outlook` boolean, required
    - `drafts` OutgoingDraft[], required
      - `id` string, uuid, required
      - `category` string, required
      - `recipient_mode` 'individual' | 'bcc', required
      - `to_recipients` OutgoingRecipientView[], required
        - `email` string, required
        - `name` string, nullable, required
        - `source_id` string, uuid, required
        - `source_kind` 'bankrupt' | 'creditor' | 'director' | 'employee' | 'manual' | 'organisation' | 'premises' | 'security', required
      - `bcc_recipients` OutgoingRecipientView[], required
        - `email` string, required
        - `name` string, nullable, required
        - `source_id` string, uuid, required
        - `source_kind` 'bankrupt' | 'creditor' | 'director' | 'employee' | 'manual' | 'organisation' | 'premises' | 'security', required
      - `subject` string, required
      - `body_html` string, required
      - `document_version_ids` string[], required
      - `provider_state` 'pending' | 'created' | 'failed' | 'sent', required
      - `outlook_web_url` string, nullable, required
      - `sender_user` DayOnesMailboxUser, required
        - `user_id` string, uuid, required
        - `name` string, required
        - `email` string, required
      - `can_open_in_outlook` boolean, required
      - `safe_issue_code` string, nullable, required
      - `safe_issue_detail` string, nullable, required
      - `created_at` string, date-time, required
      - `updated_at` string, date-time, required
  - `operation` DayOnesOperation, required
    - `id` string, uuid, required
    - `matter_id` string, uuid, required
    - `kind` 'infotrack_search' | 'public_register_search' | 'generate_pack' | 'meeting_pack' | 'refresh_document' | 'sign_document' | 'convert_pdf' | 'generate_director_pack' | 'generate_outgoings', required
    - `target_key` string, required
    - `state` 'queued' | 'running' | 'waiting' | 'completed' | 'failed' | 'cancelled', required
    - `stage` string, nullable, required
    - `version` integer, required
    - `poll_url` string, required
    - `created_at` string, date-time, required
    - `updated_at` string, date-time, required
    - `started_at` string, date-time, nullable, required
    - `terminal_at` string, date-time, nullable, required
    - `safe_issue_code` string, nullable, required
    - `safe_issue_detail` string, nullable, required
    - `document_types` string[], required
    - `document_ids` string[], required
    - `allowed_actions` string[], required
    - `template_release_updated` boolean, required

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/ender/apis/ender-backend.md) - [All operations](https://skmtc.dev/ender/apis/ender-backend/llms.txt) - [OpenAPI document](https://skmtc.dev/ender/apis/ender-backend/revisions/bf4373130521?raw)
