Skip to main content
PUT
/
api
/
own-restricted-list
/
{id}
updateList
curl --request PUT \
  --url https://api.artemis.cynopsis.co/api/own-restricted-list/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Domain-ID: <x-domain-id>' \
  --data '
{
  "listName": "<string>",
  "active": true,
  "domainIds": [
    123
  ]
}
'
import requests

url = "https://api.artemis.cynopsis.co/api/own-restricted-list/{id}"

payload = {
    "listName": "<string>",
    "active": True,
    "domainIds": [123]
}
headers = {
    "X-Domain-ID": "<x-domain-id>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)
const options = {
  method: 'PUT',
  headers: {
    'X-Domain-ID': '<x-domain-id>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({listName: '<string>', active: true, domainIds: [123]})
};

fetch('https://api.artemis.cynopsis.co/api/own-restricted-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://api.artemis.cynopsis.co/api/own-restricted-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([
    'listName' => '<string>',
    'active' => true,
    'domainIds' => [
        123
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "X-Domain-ID: <x-domain-id>"
  ],
]);

$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://api.artemis.cynopsis.co/api/own-restricted-list/{id}"

	payload := strings.NewReader("{\n  \"listName\": \"<string>\",\n  \"active\": true,\n  \"domainIds\": [\n    123\n  ]\n}")

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

	req.Header.Add("X-Domain-ID", "<x-domain-id>")
	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://api.artemis.cynopsis.co/api/own-restricted-list/{id}")
  .header("X-Domain-ID", "<x-domain-id>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"listName\": \"<string>\",\n  \"active\": true,\n  \"domainIds\": [\n    123\n  ]\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.artemis.cynopsis.co/api/own-restricted-list/{id}")

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

request = Net::HTTP::Put.new(url)
request["X-Domain-ID"] = '<x-domain-id>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"listName\": \"<string>\",\n  \"active\": true,\n  \"domainIds\": [\n    123\n  ]\n}"

response = http.request(request)
puts response.read_body
{
  "active": true,
  "createdAt": {
    "date": 123,
    "day": 123,
    "hours": 123,
    "minutes": 123,
    "month": 123,
    "nanos": 123,
    "seconds": 123,
    "time": 123,
    "timezoneOffset": 123,
    "year": 123
  },
  "createdBy": {
    "email": "<string>",
    "firstName": "<string>",
    "fullName": "<string>",
    "id": 123,
    "lastName": "<string>"
  },
  "domains": [
    {
      "id": 123,
      "name": "<string>"
    }
  ],
  "id": 123,
  "listName": "<string>",
  "nameOnList": 123,
  "updatedAt": {
    "date": 123,
    "day": 123,
    "hours": 123,
    "minutes": 123,
    "month": 123,
    "nanos": 123,
    "seconds": 123,
    "time": 123,
    "timezoneOffset": 123,
    "year": 123
  },
  "updatedBy": {
    "email": "<string>",
    "firstName": "<string>",
    "fullName": "<string>",
    "id": 123,
    "lastName": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

​
X-Domain-ID
integer<int64>
required

X-Domain-ID

Path Parameters

​
id
integer<int64>
required

id

Body

application/json

request

​
listName
string
required
​
active
boolean
​
domainIds
integer<int64>[]

Response

OK

​
active
boolean
​
createdAt
Timestamp · object
​
createdBy
UserInfo · object
​
domains
DomainDto · object[]
​
id
integer<int64>
​
listName
string
​
nameOnList
integer<int32>
​
updatedAt
Timestamp · object
​
updatedBy
UserInfo · object