Update a feature

patch https://api.productboard.com/features/{id}

Updates a specific feature.

Responses

Response body

object

errors

array of objects

required

Errors that occurred.

errors*

object

code

string

required

A unique, machine-readable and stable code that identifies this error. Consult the list below for possible values and their meanings:

feature.notFound - Requested feature could not be found.
feature.deletionForbidden.isParent - Requested feature could not be deleted since it has subfeatures.
feature.limitExceeded - It's not possible to create new features via API in this space, you reached the limit.
product.notFound - Requested product could not be found.
component.notFound - Requested component could not be found.
parent.notFound - Entity specified as a parent could not be found.
parent.invalid - Specified entity (e.g. subfeature) can not be a parent of another entity in feature hierarchy.
parent.invalidHierarchy - Specified entity can not be a parent of another entity in feature hierarchy as it violates one of the constraints:
- Feature's parent can not be of type subfeature.
- Updated feature can not have any subfeatures, if parent is of type feature.
- Updated feature can not be a parent of itself in a hierarchy tree.
featureStatus.notFound - Requested feature status could not be found.
featureStatus.name.ambiguous - Feature status could not be updated to a status with given name since the name is not unique, i.e. there is more than one status of that name. You can either specify the new status using its ID or make the names unique.
featureStatus.idAndNameSpecified - Feature status could not be updated since both ID and name was specified. It's possible to specify only one of them.
featureStatus.notSpecified - Feature status could not be updated since it was not specified. You can either skip status update entirely by not setting the status field or you have to specify id or name.
type.invalid - The selected entity cannot be a parent of the entity being created/updated. (e.g. A component cannot be a parent of a subfeature.)
startDate.invalidValue - Start date has invalid value. The timeframe must adhere to the timeframe granularity, if set.
startDate.isMissing - Start date is missing.
startDate.invalidFormat - Start date has invalid format.
timeframeGranularity.invalidValue - Timeframe granularity has invalid value.
member.notFound - Specified member is not a valid member in requested space.

Note that more detail about what exactly happened is usually provided within the other properties of this
object. Consult Error codes if you can't find your error here.

title

string

required

A short, human-readable summary of the problem that doesn't change from occurrence to occurrence of the problem.

detail

string

required

A human-readable explanation specific to this occurrence of the problem.

source

object

An object containing references to the source of the error.

Response body

object

errors

array of objects

required

Errors that occurred.

errors*

object

code

string

required

A unique, machine-readable and stable code that identifies this error. Consult the list below for possible values and their meanings:

feature.notFound - Requested feature could not be found.
feature.deletionForbidden.isParent - Requested feature could not be deleted since it has subfeatures.
feature.limitExceeded - It's not possible to create new features via API in this space, you reached the limit.
product.notFound - Requested product could not be found.
component.notFound - Requested component could not be found.
parent.notFound - Entity specified as a parent could not be found.
parent.invalid - Specified entity (e.g. subfeature) can not be a parent of another entity in feature hierarchy.
parent.invalidHierarchy - Specified entity can not be a parent of another entity in feature hierarchy as it violates one of the constraints:
- Feature's parent can not be of type subfeature.
- Updated feature can not have any subfeatures, if parent is of type feature.
- Updated feature can not be a parent of itself in a hierarchy tree.
featureStatus.notFound - Requested feature status could not be found.
featureStatus.name.ambiguous - Feature status could not be updated to a status with given name since the name is not unique, i.e. there is more than one status of that name. You can either specify the new status using its ID or make the names unique.
featureStatus.idAndNameSpecified - Feature status could not be updated since both ID and name was specified. It's possible to specify only one of them.
featureStatus.notSpecified - Feature status could not be updated since it was not specified. You can either skip status update entirely by not setting the status field or you have to specify id or name.
type.invalid - The selected entity cannot be a parent of the entity being created/updated. (e.g. A component cannot be a parent of a subfeature.)
startDate.invalidValue - Start date has invalid value. The timeframe must adhere to the timeframe granularity, if set.
startDate.isMissing - Start date is missing.
startDate.invalidFormat - Start date has invalid format.
timeframeGranularity.invalidValue - Timeframe granularity has invalid value.
member.notFound - Specified member is not a valid member in requested space.

Note that more detail about what exactly happened is usually provided within the other properties of this
object. Consult Error codes if you can't find your error here.

title

string

required

A short, human-readable summary of the problem that doesn't change from occurrence to occurrence of the problem.

detail

string

required

A human-readable explanation specific to this occurrence of the problem.

source

object

An object containing references to the source of the error.

Language

Credentials

Bearer

JWT


xxxxxxxxxx
1
curl --request PATCH \
2
     --url https://api.productboard.com/features/id \
3
     --header 'X-Version: 1' \
4
     --header 'accept: application/json' \
5
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success, the feature has been updated.

400Bad request.

404Not found.