Skip to main content

PUT /cards

Description

Updates the details of a specific 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 URL:

NameTypeDescription
idnumberRequired. The unique identifier of the card to update.

Payload

The server expects a JSON object containing the card details, including both existing and updated properties.

NameTypeDescription
labelstringRequired. The title of the card being updated.
descriptionstringRequired. A description of the card.
columnnumberRequired. The ID of the column where the card is located.
rownumberRequired. The ID of the row where the card is placed.
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 percentage, ranging from 0 to 100.
attachedobjectRequired. An array containing information about attached files. Refer to the example in cards
colorstringRequired. The HEX color code for the card's top border.
prioritynumberRequired. The ID representing the card's priority.
usersobjectRequired. An array with IDs of users assigned to the card. See example in 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": []
},
}

Additional examples of the card object can be found in the cards section.

Response

On success, the server responds with an empty JSON object.

The HTTP status code indicates the result of the request: 200 for success, or 500 if an error occurs.


Related articles: Working with server