PUT/banned-users/:id/

Update banned email or domain

You can update a list of existing banned user.

Attributes	Type	Required	Description
id	integer	yes	A unique identifier for a banned user.
banned_name	string	yes	A banned user name.
is_domain	boolean	no	A flag that determines if banned name is email or domain.

Request

CURL

curl -X PUT
"https://<your_app_subdomain>.user.com/api/public/banned-users/:id/"
-H 'Authorization: Token <your_64_char_api_key>' \
-H 'Content-Type: application/json' \
-d '{
  "banned_name": "test@mail.com"
}'

JavaScript

  var data = JSON.stringify({
    "banned_name": "test@mail.com"
  });

  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/banned-users/:id/");
  xhr.setRequestHeader("Authorization", "Token <your_64_char_api_key>");
  xhr.setRequestHeader("Content-Type", "application/json");

  xhr.send(data);

PHP

  <?php
    
  $curl = curl_init();

  curl_setopt_array($curl, array(
    CURLOPT_URL => "https://<your_app_subdomain>.user.com/api/public/banned-users/: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   \"banned_name\": \"test@mail.com\"\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;
  }

Python

  import requests
    
  url = "https://<your_app_subdomain>.user.com/api/public/banned-users/:id/"

  payload = "{\n   \"banned_name\": \"test@mail.com\"\n}"
  headers = {
      'Authorization': "Token <your_64_char_api_key>",
      'Content-Type': "application/json"
      }

  response = requests.request("PUT", url, data=payload, headers=headers)

  print(response.text)

Response

  {
      "id": 36,
      "banned_name": "test@mail.com",
      "is_domain": false
  }