Skip to main content

Create release

POST 
/projects/:id/releases

Create release

Request​

Path Parameters

    id uuidrequired

    Resource UUID.

Header Parameters

    Idempotency-Key string

    Optional idempotency key (24 h cache). Repeat calls with the same key and path return the cached response.

Body

required

    namestringrequired
    descriptionstring | nullnullable
    versionstring | nullnullable
    statusstring

    Possible values: [planning, active, in_progress, testing, completed, released, archived]

    typestring

    Possible values: [major, minor, hotfix, patch]

    targetAudiencestring | nullnullable

    Possible values: [internal, beta, limited, general]

    riskLevelstring | nullnullable

    Possible values: [low, standard, high]

    rolloutPercentagestring | nullnullable
    releaseNotesstring | nullnullable
    retrospectiveNotesstring | nullnullable
    dependsOnReleaseIdstring | nullnullable
    cascadeAdvanceboolean

    startDate

    object

    required

    anyOf

    string

    endDate

    object

    required

    anyOf

    string

    releasedAtstring | nullnullable
    lowCoststring | nullnullable
    mediumCoststring | nullnullable
    highCoststring | nullnullable
    committedCoststring | nullnullable
    costUpdatedAtstring | nullnullable
    costSourcestring | nullnullable
    updatedAtstring

Created

Schema

    iduuidrequired
    Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
    projectIduuidrequired
    Example: 7b1e2c3d-0000-0000-0000-000000000001
    namestringrequired
    Example: v2.3.0
    descriptionstring | nullnullablerequired
    Example: Performance improvements and bug fixes.
    versionstring | nullnullablerequired
    Example: 2.3.0
    statusstringrequired

    Possible values: [planning, active, in_progress, testing, completed, released, archived]

    Example: planning
    typestringrequired

    Possible values: [major, minor, hotfix, patch]

    Example: minor
    startDatedate-timerequired
    Example: 2025-02-01T00:00:00Z
    endDatedate-timerequired
    Example: 2025-02-28T00:00:00Z
    releasedAtdate-timenullablerequired
    Example: null
    createdAtdate-timerequired
    Example: 2025-01-01T00:00:00Z
    updatedAtdate-timerequired
    Example: 2025-01-15T10:30:00Z