---
title: "Create a Dimension"
method: POST
path: "/dimensions"
tags: ["Dimensions"]
---

# Create a Dimension

`POST /dimensions`

This endpoint creates a dimension.

## Query parameters

- `can_be_mapped` boolean
- `inactive` boolean
- `include_tags` boolean
- `tld_id` integer

## Headers

- `X-Company-ID` string, required

## Request body

- DimensionListApiDocAttributes2
  - `name` string, required
  - `parent_id` integer, required
  - `parent_name` string, required
  - `write_protection` 'NONE' | 'BLOCK' | 'ACTUALS' | 'AI', required — * `NONE` - None * `BLOCK` - Block * `ACTUALS` - Actuals * `AI` - AI

## Response `200`

The list of dimensions

- DimensionList
  - `id` integer, required
  - `parent_id` integer, nullable, required
  - `name` string, required
  - `active` boolean, required
  - `status` 'ENABLED' | 'DISABLING_VALUES' | 'CLEARING_VALUES' | 'VALUES_CLEARED' | 'DISABLED' — * `ENABLED` - Enabled * `DISABLING_VALUES` - Disabling Values * `CLEARING_VALUES` - Clearing Values * `VALUES_CLEARED` - Values Cleared * `DISABLED` - Disabled
  - `type` 'BASIC' | 'FORMULA' | 'TAG' — * `BASIC` - Basic * `FORMULA` - Formula * `TAG` - Tag
  - `rollup_type` union
    - 'SUM' | 'AVERAGE' | 'BALANCE' | 'BEGINNING_BALANCE' — * `SUM` - Sum * `AVERAGE` - Average * `BALANCE` - Ending Balance * `BEGINNING_BALANCE` - Beginning Balance
    - ''
    - unknown
  - `formula` string, required
  - `write_protection` 'NONE' | 'BLOCK' | 'ACTUALS' | 'AI' — * `NONE` - None * `BLOCK` - Block * `ACTUALS` - Actuals * `AI` - AI
  - `position` integer
  - `special_case_id` string, nullable
  - `date` string, date, nullable
  - `has_children` boolean
  - `write_block_reason` string, required — If the dimension cannot be written to, return the reason why. Otherwise, return nothing. Args: obj: The model object to be checked if can be written to. Returns: str (Optional): The error blocking the dimension from being written to, if one exists
  - `metadata` string, nullable
  - `currency_id` integer, nullable, required
  - `data_table_id` string, uuid, nullable, required
  - `number` string, nullable
  - `created_at` string, date-time, required
  - `description` string, nullable
  - `formulas` object[], required
  - `tag_member_ids` integer[], required
  - `children_ids` integer[], required

---

[API](https://skmtc.net/cubesoftware/apis/cube-api.md) · [All operations](https://skmtc.net/cubesoftware/apis/cube-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cubesoftware/cube-api/revisions/67d9f45bb99b/schema)