Skip to main content
PUT
/
lists
/
{list_id}
Update List
curl --request PUT \
  --url https://jobs-api.registercheck.de/api/v2/lists/{list_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "emoji": "<string>",
  "tags": [
    "<string>"
  ]
}
'
import requests

url = "https://jobs-api.registercheck.de/api/v2/lists/{list_id}"

payload = {
"name": "<string>",
"description": "<string>",
"emoji": "<string>",
"tags": ["<string>"]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
emoji: '<string>',
tags: ['<string>']
})
};

fetch('https://jobs-api.registercheck.de/api/v2/lists/{list_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://jobs-api.registercheck.de/api/v2/lists/{list_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'description' => '<string>',
'emoji' => '<string>',
'tags' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://jobs-api.registercheck.de/api/v2/lists/{list_id}"

payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"emoji\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ]\n}")

req, _ := http.NewRequest("PUT", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.put("https://jobs-api.registercheck.de/api/v2/lists/{list_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"emoji\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ]\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://jobs-api.registercheck.de/api/v2/lists/{list_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"emoji\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ]\n}"

response = http.request(request)
puts response.read_body
{
  "id": "<string>",
  "name": "<string>",
  "created_at": "<string>",
  "updated_at": "<string>",
  "description": "<string>",
  "emoji": "<string>",
  "items": [
    {
      "entity_id": "<string>",
      "entity_name": "<string>",
      "id": "<string>",
      "created_at": "<string>",
      "updated_at": "<string>",
      "is_company": true,
      "register_number": "<string>",
      "birth_date": "<string>",
      "notes": "<string>",
      "watchlist_subscription_id": "<string>"
    }
  ],
  "tags": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ],
  "is_watchlist": false
}
{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}

Authorizations

Authorization
string
header
required

Enter your API key

Path Parameters

list_id
string
required

Body

application/json

Request model for updating an existing list

name
string | null

Updated name of the list

Required string length: 1 - 255
description
string | null

Updated description of the list

Maximum string length: 1000
emoji
string | null

Updated emoji icon for the list

Maximum string length: 10
tags
string[] | null

Updated list of tag names

Response

Successful Response

Response model for a target list

id
string
required

Unique identifier for the list

name
string
required

Name of the list

created_at
string
required

ISO timestamp when the list was created

updated_at
string
required

ISO timestamp when the list was last updated

description
string | null

Optional description of the list

emoji
string | null

Optional emoji icon for the list

items
ListItemResponse ยท object[]

List of entities in this list

tags
TagResponse ยท object[]

Tags associated with this list

is_watchlist
boolean
default:false

Whether this list is a watchlist with active monitoring