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>"
  ]
}
'

import requests

url = "https://crossproductroadmapbackend.vercel.app/api/v1/initiatives/{id}"

payload = {
    "title": "<string>",
    "subProductId": "<string>",
    "statusId": "<string>",
    "startQuarter": "<string>",
    "endQuarter": "<string>",
    "classificationId": "<string>",
    "ownerId": "<string>",
    "notes": "<string>",
    "tagIds": ["<string>"]
}
headers = {
    "x-tenant-slug": "<x-tenant-slug>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {
    'x-tenant-slug': '<x-tenant-slug>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    title: '<string>',
    subProductId: '<string>',
    statusId: '<string>',
    startQuarter: '<string>',
    endQuarter: '<string>',
    classificationId: '<string>',
    ownerId: '<string>',
    notes: '<string>',
    tagIds: ['<string>']
  })
};

fetch('https://crossproductroadmapbackend.vercel.app/api/v1/initiatives/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://crossproductroadmapbackend.vercel.app/api/v1/initiatives/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'title' => '<string>',
    'subProductId' => '<string>',
    'statusId' => '<string>',
    'startQuarter' => '<string>',
    'endQuarter' => '<string>',
    'classificationId' => '<string>',
    'ownerId' => '<string>',
    'notes' => '<string>',
    'tagIds' => [
        '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "x-tenant-slug: <x-tenant-slug>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://crossproductroadmapbackend.vercel.app/api/v1/initiatives/{id}"

	payload := strings.NewReader("{\n  \"title\": \"<string>\",\n  \"subProductId\": \"<string>\",\n  \"statusId\": \"<string>\",\n  \"startQuarter\": \"<string>\",\n  \"endQuarter\": \"<string>\",\n  \"classificationId\": \"<string>\",\n  \"ownerId\": \"<string>\",\n  \"notes\": \"<string>\",\n  \"tagIds\": [\n    \"<string>\"\n  ]\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("x-tenant-slug", "<x-tenant-slug>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://crossproductroadmapbackend.vercel.app/api/v1/initiatives/{id}")
  .header("x-tenant-slug", "<x-tenant-slug>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"title\": \"<string>\",\n  \"subProductId\": \"<string>\",\n  \"statusId\": \"<string>\",\n  \"startQuarter\": \"<string>\",\n  \"endQuarter\": \"<string>\",\n  \"classificationId\": \"<string>\",\n  \"ownerId\": \"<string>\",\n  \"notes\": \"<string>\",\n  \"tagIds\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://crossproductroadmapbackend.vercel.app/api/v1/initiatives/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["x-tenant-slug"] = '<x-tenant-slug>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"title\": \"<string>\",\n  \"subProductId\": \"<string>\",\n  \"statusId\": \"<string>\",\n  \"startQuarter\": \"<string>\",\n  \"endQuarter\": \"<string>\",\n  \"classificationId\": \"<string>\",\n  \"ownerId\": \"<string>\",\n  \"notes\": \"<string>\",\n  \"tagIds\": [\n    \"<string>\"\n  ]\n}"

response = http.request(request)
puts response.read_body

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>"
      }
    }
  ]
}

{
  "error": "<string>"
}

{
  "error": "<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 | null

Show child attributes

subProduct · object | null

Show child attributes

classification · object | null

Show child attributes

user · object | null

Assigned owner

Show child attributes

tags · object[]

Show child attributes