---
title: "Create a new release candidate for one or more items."
method: POST
path: "/releasepackages/release/{wfid}"
tags: ["ReleasePackage"]
---

# Create a new release candidate for one or more items.

`POST /releasepackages/release/{wfid}`

## Request

- Base URL: `https://api.onshape.com/api/v17`
- URL: `https://api.onshape.com/api/v17/releasepackages/release/{wfid}`
- Auth: OAuth 2 and HTTP basic
  - Authorization code: `/oauth/authorize`
  - Token URL: `/oauth/token` scopes: `OAuth2Write`

This endpoint creates a release candidate with items added to it. It does <b>not</b> release the candidate. Once the release candidate is successfully created, use [updateReleasePackage](#/ReleasePackage/updateReleasePackage) to update all desired item/candidate properties, and transition it to the desired release state. See [API Guide: Release Management](https://onshape-public.github.io/docs/api-adv/relmgmt/) for examples. 
 
To add items from other documents, you must select `Allow adding items from other documents` in your [Release management settings](https://cad.onshape.com/help/Content/Plans/release_management_2.htm#rel_candidate_dialog).

## Path parameters

- `wfid` string, required

## Query parameters

- `debugMode` boolean

## Request body

- BTReleasePackageParams: Parameters for creating a release candidate.
  - `items` BTReleasePackageItemParams[]: List of items to include in the release candidate.
    - `configuration` string: Encoded configuration string for the item. See [encodeConfigurationMap](#/Element/encodeConfigurationMap).
    - `documentId` string: Document containing the item.
    - `elementId` string: Element containing the item.
    - `elementType` integer: Type of element, which can be: `0: Part Studio, 1: Assembly, 2: Drawing. 4: Blob`
    - `flatPartId` string: Flat part ID.
    - `href` string: Href link to the item.
    - `id` string: ID of the item. Use this to reference the item when updating it. See [getReleasePackage](#/ReleasePackage/getReleasePackage).
    - `parentId` string: ID of the parent item, if any.
    - `partId` string: ID of the part to add to the release candidate.
    - `partIdentity` string: Part identity string for the part to add to the release candidate.
    - `partNumber` string: Part number. See [nextNumbers](#/NumberingScheme/nextNumbers).
    - `properties` BTPropertyValueParam[]: List of property values associated with the item.
      - `propertyId` string: Id of the property to set.
      - `value` object: Value to set for the property. User property values must be a list of `{ "id": "idValue" }` maps.
    - `revisionId` string: Revision ID of the item. Use when adding items to an obsoletion candidate.
    - `versionId` string: Version containing the item.
    - `workspaceId` string: Workspace containing the item.

## Response `default`

default response

---

[API](https://skmtc.dev/onshape/apis/onshape-rest-api.md) - [All operations](https://skmtc.dev/onshape/apis/onshape-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/onshape/apis/onshape-rest-api/revisions/c5c4c780f831?raw)