Skip to main content

PUT /rows

Description

Updates the data for a specific row (swimlane) and returns an empty JSON object.

This route processes an HTTP PUT request sent to the /rows/{id} endpoint.

Path parameters

The following parameter is included in the request URL:

NameTypeDescription
idnumberRequired. The ID of the row (swimlane) that needs to be updated.

Payload

The server expects a JSON object containing all properties of the row, including both unchanged and updated values.

NameTypeDescription
labelstringRequired. The name of the row to update.
collapsedbooleanOptional. Indicates the row's state: true if the row is initially collapsed, or false if expanded (default).

Example:

{
"row": {
"label": "Row 1",
"collapsed": false,
}
}

For another example of the row object, see the rows section.

Response

If the update is successful, the server returns an empty JSON object.

The HTTP status code indicates the result of the request: 200 for success and 500 for failure.


Related articles: Working with server