Update entity

Updates one or more fields of a Entities. Use fields for full replacement of values, or patch for granular changes like adding/removing items in list-type fields. You must use either fields or patch – not both.

The patch property supports these operations:

• set – same as setting a value via fields
• addItems – add one or more values to a list field
• removeItems – remove values from a list field
• clear – erase the value of the field

Limitations

• Providing both fields and patch in the same request will return an error.

Code examples

Replace <entity-id> with the ID of the Entities. Replace <your-token> with a valid API token.

Rename a feature and update its status:

curl -X PATCH "https://api.productboard.com/v2/entities/<entity-id>" \
  -H "Authorization: Bearer <your-token>" \
  -H "Content-Type: application/json" \
  -d '{
    "data": {
      "fields": {
        "name": "New onboarding flow",
        "status": { "name": "In Progress" }
      }
    }
  }'

Update the description and clear a date field:

curl -X PATCH "https://api.productboard.com/v2/entities/<entity-id>" \
  -H "Authorization: Bearer <your-token>" \
  -H "Content-Type: application/json" \
  -d '{
    "data": {
      "patch": [
        { "op": "set", "path": "description", "value": "Updated notes after customer feedback." },
        { "op": "clear", "path": "timeframe.startDate" }
      ]
    }
  }'