CreatePathwayRequest

A request or response body; the type column links to the schemas it refers to.

CreatePathwayRequest

FieldTypeRequiredDescription
owner_organization_idstring (uuid)yes

Organization the pathway belongs to. Always required.

owner_department_idstring (uuid)no

Omit for a pathway owned by the organization directly.

slugstringyes

Unique within the organization. Slugs are lowercase letters and digits in words separated by single hyphens, like new-hire-path.

1–100 characters · matches ^[a-z0-9]+(-[a-z0-9]+)*$

namestringyes

1–200 characters

description_markdownstringno

Omit or send empty for no markdown description.

at most 50000 characters

jsonExample
{
  "owner_organization_id": "1b671a64-40d5-491e-99b0-da01ff1f3341",
  "owner_department_id": "1b671a64-40d5-491e-99b0-da01ff1f3341",
  "slug": "new-hire-path",
  "name": "New hire path",
  "description_markdown": "string"
}