Skip to main content
POST
Create value unit

Authorizations

X-API-Key
string
header
required

Owner-typed API key (ORGANIZATION, PERSON, VALUE_UNIT). Manage org-scoped lifecycle with /v1/public-api-keys; cross-org governance is restricted to /v1/sys/public-api-keys.

Body

application/json

Create payload for a value unit. Resolve typeId first via GET /v1/public/value-units/types.

name
string
required
Maximum string length: 150
Pattern: \S
typeId
string
required

Value unit type tag id in the authenticated organization.

Pattern: \S
Example:

"c663935d-9c74-45a1-bdd4-5975eb0845f1"

parentId
string

Optional parent value unit id in the authenticated organization.

Example:

"9aa9f0fb-a6a8-4ca8-b9ff-d0d8451aa8b7"

key
string

Optional key. If omitted, a key is generated.

Required string length: 2 - 10
Pattern: [a-zA-Z][a-zA-Z0-9_]+
Example:

"ENG"

description
string
Maximum string length: 2000
externalId
string

Optional external identifier used by upstream systems for stable integration mapping.

Maximum string length: 255
Example:

"hris-vu-1001"

estimationType
object

Optional estimation type for root value units.

organizationalUnitIds
string[]

Optional organizational unit ids associated with the value unit.

tags
string[]

Optional ad-hoc custom tags for the value unit. Omit to keep it untagged.

Maximum array length: 5
Example:

Response

Value unit created

id
string
name
string
key
string
description
string
externalId
string
parentId
string
parentName
string
typeId
string
typeName
string
estimationType
enum<string>
Available options:
NO_ESTIMATE,
TIME_POINTS,
STORY_POINTS,
T_SHIRT_SIZES,
HOURS
organizationalUnits
object[]
tags
object[]
leads
object[]
createdBy
object
teams
object[]
workboard
object
definitionsOfDone
object[]
sprints
object[]
hasChildren
boolean
deleted
boolean