Update a list

PATCH 
https://try.karakeep.app/api/v1/lists/:listId

Update list by its id

Request

Path Parameters

listId ListIdrequired

application/json

Body

The data to update. Only the fields you want to update need to be provided.

namestring

Possible values: non-empty and <= 40 characters

descriptionstringnullable

Possible values: <= 100 characters

iconstring
parentIdstringnullable
querystring

Possible values: non-empty

publicboolean

Responses

200

The updated list

application/json

Schema

Schema

idstringrequired
namestringrequired
descriptionstringnullable
iconstringrequired
parentIdstringnullablerequired
typestring
Possible values: [manual, smart]
Default value: manual
querystringnullable
publicbooleanrequired

Example (auto)

{
  "id": "string",
  "name": "string",
  "description": "string",
  "icon": "string",
  "parentId": "string",
  "type": "manual",
  "query": "string",
  "public": true
}

404

List not found

application/json

Schema

Schema

codestringrequired
messagestringrequired

Example (auto)

{
  "code": "string",
  "message": "string"
}

Authorization: http

name: bearerAuthtype: httpscheme: bearerbearerFormat: JWT

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Patch, "https://try.karakeep.app/api/v1/lists/:listId");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var content = new StringContent("{\n  \"name\": \"string\",\n  \"description\": \"string\",\n  \"icon\": \"string\",\n  \"parentId\": \"string\",\n  \"query\": \"string\",\n  \"public\": true\n}", null, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request Collapse all

Base URL

https://try.karakeep.app/api/v1

Auth

Bearer Token

Parameters

listId — pathrequired

Body

{
  "name": "string",
  "description": "string",
  "icon": "string",
  "parentId": "string",
  "query": "string",
  "public": true
}

ResponseClear

Click the Send API Request button above and see the response here!