API Reference

Create Bar

post
https://{defaultHost}/api/v2/bars

Adds a new Bar to the specifed Roadmap. All Bars added will be parked by default.

Body Params
string
required

Title of the bar.

string | null

In-depth explanation of what the bar represents.

date | null

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

date | null

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

string | null

Why this bar is important.

string | null

Additional information to be shared.

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
array of strings

Keywords and terms associated with the bar.

tags
string | null

The lane assigned to the bar.

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
boolean

Whether or not this bar is a container

boolean
Defaults to true

Whether or not this bar is parked

integer

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

integer
required

Id of the roadmap to which we want to add the bar

Responses
201

bar successfully created

Updated over 1 year ago

Language
Credentials
Bearer
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated over 1 year ago