Skip to main content

PUT /cards

Description

Updates the data of a specified card and returns an empty JSON object.

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

Path parameters

The following parameter is included in the request path:

NameTypeDescription
idnumberRequired. The ID of the card to update.

Payload

The server expects a JSON object containing the card object with all its properties, including both unchanged and updated values.

NameTypeDescription
labelstringRequired. The name of the card to update.
descriptionstringRequired. The card's description.
columnnumberRequired. The ID of the column the card belongs to.
rownumberRequired. The ID of the row the card belongs to.
start_datestringRequired. The start date in ISO format yyyy-MM-dd'T'HH:mm:ss.SSSXXX
end_datestringRequired. The end date in ISO format yyyy-MM-dd'T'HH:mm:ss.SSSXXX
progressnumberRequired. The progress value, ranging from 0 to 100.
attachedobjectRequired. An array containing data about attached file(s). See the object example here cards
colorstringRequired. The color of the card's top line in HEX format.
prioritynumberRequired. The priority ID of the card.
usersobjectRequired. An array of assigned user 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": []
},
}

Another example of the card object is available in the cards section.

Response

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

The HTTP status code indicates the result of the request: success with status 200, or failure with status 500.


Related articles: Working with server