Skip to main content

PUT /cards

Description

Updates data on a specified card and returns an empty json object

The route handles the HTTP PUT request made to the /cards/{id} path.

Query parameters

The query parameter sent in the request line is the following:

NameTypeDescription
idnumberRequired. The ID of the card to be updated.

Payload

The server needs to receive a json object with the card object in it that contains all card properties (both unchanged and new/modified).

NameTypeDescription
labelstringRequired. The name of the card to be updated.
descriptionstringRequired. The card description.
columnnumberRequired. The ID of the column the card refers to.
rownumberRequired. The ID of the row the card refers to.
start_datestringRequired. The start date in the ISO format yyyy-MM-dd'T'HH:mm:ss.SSSXXX
end_datestringRequired. The end date in the ISO format yyyy-MM-dd'T'HH:mm:ss.SSSXXX
progressnumberRequired. The progress bar value in the range from 0 to 100 points.
attachedobjectRequired. An array with data of the attached file(s). See the object example here cards
colorstringRequired. The color of the card top line in HEX.
prioritynumberRequired. The card priority ID.
usersobjectRequired. An array with the assigned users IDs. See the object example here cardShape

Example:

{
"card": {
"label": "Drag and drop",
"description": "",
"column": 3,
"row": 1,
"start_date": null,
"end_date": "2018-01-01T00:00:00Z",
"progress": 100,
"attached": [],
"color": "#58C3FE",
"priority": 2,
"users": []
},
}

You can find another example of the card object in the cards section.

Response

In case of the success status, an empty json object is returned back.

The HTTP status code shows whether the request succeeds (response.status == 200) or fails (response.status == 500).


Related articles: Working with server