PUT/lists/:id/

Update list

You can update a specific list.

Attributes	Type	Required	Description
id	integer	yes	A unique identifier for the list which is given by User.com automatically.
description	string	no	A list description.
name	string	yes	A list name.

Request

CURL
JavaScript
PHP
Python

curl -X PUT -H "Authorization: Token <your_64_char_api_key>"
     -H "Accept: */*; version=2" -H "Content-Type: application/json" -d '{
      "name": "Updated list name",
      "description": "Updated list description"
    }' "https://<your_app_subdomain>.user.com/api/public/lists/:id/"

  var data = JSON.stringify({
    "name": "Updated list name",
    "description": "Updated list description"
  });
  
  var xhr = new XMLHttpRequest();
  xhr.withCredentials = true;
  
  xhr.addEventListener("readystatechange", function () {
    if (this.readyState === 4) {
      console.log(this.responseText);
    }
  });
  
  xhr.open("PUT", "https://<your_app_subdomain>.user.com/api/public/lists/:id/");
  xhr.setRequestHeader("authorization", "Token <your_64_char_api_key>");
 xhr.setRequestHeader("accept", "*/*; version=2");
  xhr.setRequestHeader("content-type", "application/json");
 
  
  xhr.send(data);

 <?php
  
  $curl = curl_init();
  
  curl_setopt_array($curl, array(
    CURLOPT_URL => "https://<your_app_subdomain>.user.com/api/public/lists/: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 => "{\n  \"name\": \"Updated list name\",\n  \"description\": \"Updated list description\"\n}",
    CURLOPT_HTTPHEADER => array(
      "Accept: */*; version=2",
      "authorization: Token <your_64_char_api_key>",
      "content-type: application/json"
    ),
  ));
  
  $response = curl_exec($curl);
  $err = curl_error($curl);
  
  curl_close($curl);
  
  if ($err) {
    echo "cURL Error #:" . $err;
  } else {
    echo $response;
  }

import http.client
    
conn = http.client.HTTPSConnection("<your_app_subdomain>.user.com")

payload = "{\n  \"name\": \"Updated list name\",\n  \"description\": \"Updated list description\"\n}"

headers = {
    'authorization': "Token <your_64_char_api_key>",
    'content-type': "application/json"
    }

conn.request("PUT", "/api/public/lists/:id/", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Request​

Request