Update project

Update a project, synced to Linear. Linear sync failures are logged but do not block the local update. Requires the projects:write scope.

PATCH /projects/{id}

Update project

cURL

curl --request PATCH \
  --url https://productlane.com/api/v2/projects/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "icon": "<string>",
  "color": "<string>",
  "linear_status_id": "<string>",
  "is_visible": true
}
'

import requests

url = "https://productlane.com/api/v2/projects/{id}"

payload = {
    "name": "<string>",
    "description": "<string>",
    "icon": "<string>",
    "color": "<string>",
    "linear_status_id": "<string>",
    "is_visible": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    description: '<string>',
    icon: '<string>',
    color: '<string>',
    linear_status_id: '<string>',
    is_visible: true
  })
};

fetch('https://productlane.com/api/v2/projects/{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://productlane.com/api/v2/projects/{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([
    'name' => '<string>',
    'description' => '<string>',
    'icon' => '<string>',
    'color' => '<string>',
    'linear_status_id' => '<string>',
    'is_visible' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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://productlane.com/api/v2/projects/{id}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"icon\": \"<string>\",\n  \"color\": \"<string>\",\n  \"linear_status_id\": \"<string>\",\n  \"is_visible\": true\n}")

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

	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://productlane.com/api/v2/projects/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"icon\": \"<string>\",\n  \"color\": \"<string>\",\n  \"linear_status_id\": \"<string>\",\n  \"is_visible\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://productlane.com/api/v2/projects/{id}")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"icon\": \"<string>\",\n  \"color\": \"<string>\",\n  \"linear_status_id\": \"<string>\",\n  \"is_visible\": true\n}"

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

200

{
  "id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "color": "<string>",
  "icon": "<string>",
  "state": "<string>",
  "progress": 123,
  "sort_order": 123,
  "total_score": 123,
  "is_visible": true,
  "created_at": "<string>",
  "updated_at": "<string>",
  "linear_project_id": "<string>",
  "linear_team_ids": [
    "<string>"
  ],
  "linear_team_names": [
    "<string>"
  ]
}

{
  "message": "<string>",
  "code": "<string>",
  "issues": [
    {
      "message": "<string>"
    }
  ]
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id · string · required

Body

application/json

name · string

Minimum string length: 1

description · string | null

icon · string | null

Linear project icon identifier (Linear's internal icon set, no public list). Echo back a value from a previous response or the dashboard.

Required string length: 1 - 64

color · string | null

Hex color in #RRGGBB or #RGB form.

Pattern: ^#(?:[0-9a-fA-F]{3}|[0-9a-fA-F]{6})$

state · enum<string>

Lifecycle category. Distinct from linear_status_id, which selects a specific status within the category.

Available options: backlog, planned, started, completed, canceled

linear_status_id · string

Linear project status id. When set, state is ignored and Linear resolves the lifecycle category from the status.

is_visible · boolean

Whether the project is shown on the customer portal.

Response

200

application/json

Successful response

id · string · required

name · string · required

description · string | null · required

color · string | null · required

icon · string | null · required

Name of a Nucleo icon (PascalCase, e.g. Notepad, Atom). Must be a valid icon from https://nucleoapp.com - unknown names will not render in the dashboard or portal.

state · string | null · required

progress · number | null · required

sort_order · number · required

total_score · number · required

is_visible · boolean | null · required

created_at · string · required

updated_at · string · required

linear_project_id · string | null · required

linear_team_ids · string[] · required

linear_team_names · string[] · required