Skip to content

Updates the description of an existing basket. The description must not be empty. If the location is not given or invalid it falls back to the user's home. Returns the updated basket.

PUT
/api/baskets/{basketId}

Authorizations

api_key

Requests manipulating data need to supply a CSRF token

TypeAPI Key (header: X-CSRF-Token)

Parameters

Path Parameters

basketId*
Typestring
Required
Pattern"\\d+"

Request Body

application/json
JSON
{
"id": 0,
"description": "string",
"pictures": [
"string"
],
"contactTypes": [
[
]
],
"mobile": "string",
"telephone": "string",
"lat": 0,
"lon": 0,
"lifeTimeInDays": 0,
"weightInGrams": 0,
"status": 0,
"location": {
"lat": 52.5,
"lon": 13.4
},
"creator": {
"id": 0,
"name": "string",
"avatar": "string",
"isSleeping": true
},
"created": 0,
"updated": 0,
"until": 0,
"requestCount": 0
}

Responses

Playground

Authorization
Variables
Key
Value
Body

Samples

cURL
JavaScript
PHP
Python