Update Bar

patch https://{defaultHost}/api/v2/bars/{id}

Updates the specified Bar.

Path Params

integer

required

Body Params

name

string

Title of the bar.

description

string | null

In-depth explanation of what the bar represents.

starts_on

date | null

Date for which work associated with the bar is to begin.

ends_on

date | null

Date for which work associated with the bar is to end.

strategic_value

string | null

Why this bar is important.

notes

string | null

Additional information to be shared.

percent_done

integer | null

0 to 100

Determines the shading of the bar to indicate progress. Null is fully saturated. 0-100 displays a gradual shading until fully saturated.

tags

lane

string | null

The lane assigned to the bar.

legend

string | null

The legend assigned to the bar.

custom_text_fields

array of objects

custom_text_fields

custom_dropdown_fields

array of objects

custom_dropdown_fields

is_container

boolean

Whether or not this bar is a container

parked

boolean

Defaults to true

Whether or not this bar is parked

container_bar_id

integer

Bar ID of the container to which we want to add the bar.

Responses

204

bar successfully updated

Language

Credentials

Bearer

URL


xxxxxxxxxx
1
curl --request PATCH \
2
     --url https://app.productplan.com/api/v2/bars/id \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '{"parked":true}'

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

application/json

401authentication failed

403forbidden

422validation failed