Create an org state label

Platform module

POST/org-state-labelsorgStateLabels.create

An org's display relabel of a record state. It never mints a new lifecycle. Creates an org state label. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.

Requires the capability org.views.write.
OAuth scopes: org.
Send an Idempotency-Key header. A replay with the same key returns the original response.
Error statuses: 400, 401, 409, 422, 429. Errors are RFC 9457 problem details.

Request body: OrgStateLabelCreate

orgStateLabels.create: OrgStateLabelCreate
Field	Type	Required	Description
record_state	string	Yes	Record state relabeled. A Title Case value from the lifecycle's database enum.Constraints: pattern ^[A-Z0-9][A-Za-z0-9&'/.()-]( [A-Za-z0-9&'/.()-]+)$
label	string	Yes	Display label.Constraints: length 1 to 300

{
  "record_state": "In Review",
  "label": "With Client"
}

Response 201: OrgStateLabel

orgStateLabels.create: OrgStateLabel
Field	Type	Required	Description
id	string (uuid)	Yes	Identifier of the org state label.
org_id	string (uuid)	Yes	Identifier of the owning organization, derived from the parent row and never accepted from the caller.
created_at	string (date-time)	Yes	When the row was created.
created_by	string (uuid) \| null	Yes	Identifier of the person who created the row; null when a seed, platform or system process created it.
updated_at	string (date-time)	Yes	When the row was last updated.
updated_by	string (uuid) \| null	Yes	Identifier of the person who last updated the row; null when a seed, platform or system process updated it.
record_state	string	Yes	Record state relabeled. A Title Case value from the lifecycle's database enum.Constraints: pattern ^[A-Z0-9][A-Za-z0-9&'/.()-]( [A-Za-z0-9&'/.()-]+)$
label	string	Yes	Display label.Constraints: length 1 to 300

{
  "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "created_at": "2026-10-08T14:30:00Z",
  "created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "updated_at": "2026-10-08T14:30:00Z",
  "updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "record_state": "In Review",
  "label": "With Client"
}

Code samples

curl -X POST "$XOS_BASE_URL/org-state-labels" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"record_state":"In Review","label":"With Client"}'

const { data } = await xos.orgStateLabels.create({
    "record_state": "In Review",
    "label": "With Client"
  });

response = xos.org_state_labels.create({"record_state": "In Review", "label": "With Client"})

xos org-state-labels create --data '{"record_state":"In Review","label":"With Client"}'