---
title: "Preview Matter Defaults"
method: POST
path: "/v1/workspaces/{workspace_id}/matter-defaults/preview"
tags: ["matter-settings"]
---

# Preview Matter Defaults

`POST /v1/workspaces/{workspace_id}/matter-defaults/preview`

## 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/workspaces/{workspace_id}/matter-defaults/preview`
- Auth: HTTP bearer

## Path parameters

- `workspace_id` string, uuid, required

## Request body

- MatterDefaultsPreviewCommand
  - `matter_type` 'corporate' | 'bankruptcy', required
  - `base_name` string, required
  - `display_name` string, nullable
  - `matter_code` string, nullable
  - `folder_format` 'name_only' | 'name_and_appointment' | 'code_name_and_appointment' | 'code_and_name' | 'code_only', nullable
  - `appointment_type` string, nullable
  - `entity_acn` string, nullable
  - `entity_abn` string, nullable
  - `appointment_date` string, date, nullable

## Response `200`

Successful Response

- MatterDefaultsPreview
  - `folder_name` string, required
  - `matter_code` string, required
  - `defaults_version` integer, required
  - `matter_code_available` 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)