Header with the name X-API-Key where the value is your API key.
Body
application/json
dueDate ISO 8601 date
ISO 8601 Due date on the project, like 2024-03-12T10:52:55.714-06:00
name string
required
The name of the project
workspaceId string
required
The workspace to which the project belongs
description string
The description of the project. HTML input accepted
labels array<string>
The list of labels by name the project should have
priority string default:MEDIUM
Defaults to MEDIUM. Options are ASAP, HIGH, MEDIUM, and LOW
projectDefinitionId string
Optional ID of the project definition (template) to use. If provided, the `stages` array must also be included.
stages array<object>
Optional array of stage objects, required if `projectDefinitionId` is provided. Each object defines a stage in the project, including its definition ID, due date, and optionally, values for variables defined in that stage (e.g., assigning users to roles for that specific stage). Stages must match the order and number defined in the project definition. **Note:** Providing the wrong number of stages results in a 400 error with the message: `The number of stages in the project does not match the number of stages in the definition. Expected stages: [...]`.
stageDefinitionId string
required
ID of the stage definition.
dueDate string (ISO 8601 date)
required
Due date for this stage.
variableInstances array<object>
Optional array to assign values to variables specific to this stage. Each object requires `variableName` and `value`. Example: `{ variableName: "Tech Lead", value: "usr_123abc" }`
variableName string
required
Name of the variable definition (e.g., the "role" name being assigned). If an invalid name is provided, a 400 error is returned with a message indicating the valid variable names for this stage: `Variable name "[invalid name]" not found for stage definition ID "[stage def ID]". Valid names are: [[valid names list]]`
value string
required
The value for the variable (e.g., the user ID if the variable type is "person").
Response
200 - application/json - object
id string
required
name string
required
description string
required
The HTML contents of the description
workspaceId string
required
The id of the workspace
status object
required
The status of the project
name string
The name of the status
isDefaultStatus boolean
Whether this status is a default status for the workspace
isResolvedStatus boolean
Whether this is a resolved (terminated) status for the workspace
