Update Initiative

Only the fields you provide are changed.

PATCH /initiatives/{id}

Partially update an initiative

cURL

curl --request PATCH \
  --url https://crossproductroadmapbackend.vercel.app/api/v1/initiatives/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-tenant-slug: <x-tenant-slug>' \
  --data '
{
  "title": "<string>",
  "subProductId": "<string>",
  "statusId": "<string>",
  "startQuarter": "<string>",
  "endQuarter": "<string>",
  "classificationId": "<string>",
  "ownerId": "<string>",
  "notes": "<string>",
  "tagIds": [
    "<string>"
  ]
}
'

200

{
  "id": "<string>",
  "title": "<string>",
  "notes": "<string>",
  "startQuarter": "2026_Q1",
  "endQuarter": "2026_Q3",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "status": {
    "id": "<string>",
    "name": "<string>",
    "color": "<string>"
  },
  "subProduct": {
    "id": "<string>",
    "name": "<string>",
    "product": {
      "id": "<string>",
      "name": "<string>"
    }
  },
  "classification": {
    "id": "<string>",
    "name": "<string>",
    "color": "<string>"
  },
  "user": {
    "id": "<string>",
    "name": "<string>",
    "email": "<string>"
  },
  "tags": [
    {
      "tag": {
        "id": "<string>",
        "name": "<string>"
      }
    }
  ]
}

Authorizations

ApiKeyAuthOAuthBearer

Authorization · string · header · required

Generate an API key in your workspace Settings → API Keys. Pass it as Authorization: Bearer tab_<key> on every request.

Headers

x-tenant-slug · string · required

Your workspace slug (e.g. acme).

Path Parameters

id · string · required

Body

application/json

title · string

Maximum string length: 200

subProductId · string

statusId · string

startQuarter · string

endQuarter · string

classificationId · string

ownerId · string

notes · string

tagIds · string[]

Replaces all existing tags

Response

200

application/json

OK

id · string

title · string

notes · string | null

startQuarter · string

Example:

"2026_Q1"

endQuarter · string | null

Example:

"2026_Q3"

createdAt · string<date-time>

updatedAt · string<date-time>

status · object

Show child attributes

subProduct · object

Show child attributes

classification · object

Show child attributes

user · object

Assigned owner

Show child attributes

tags · object[]

Show child attributes