Box Developer Documentation
Log in
Latest version

Update shield list

put
https://api.box.com/2.0
/shield_lists/:shield_list_id

Updates a shield list.

Request

bearer [ACCESS_TOKEN]
application/json

Request Headers

stringin headerrequired

Version header.

Value is always 2025.0

Path Parameters

stringin pathrequired
90fb0e17-c332-40ed-b4f9-fa8908fbbb24

The unique identifier that represents a shield list. The ID for any Shield List can be determined by the response from the endpoint fetching all shield lists for the enterprise.

Request Body

Shield List Content (Country) / Shield List Content (Domain) / Shield List Content (Email) / Shield List Content (IP) objectin body

Specifies the type of elements in this Shield List and includes the elements themselves. It is not possible to update Integration Shield Lists by Public API.

stringin bodyoptional
"A list of things that are shielded"

Optional description of Shield List.

stringin bodyrequired
"My Shield List"

The name of the shield list.

Response

application/jsonShield List

Returns the shield list object.

application/jsonClient error

The shield list was not found.

application/jsonClient error

The shield list with this name already exists.

put
Update shield list
You can now try out some of our APIs live, right here in the documentation.
Log in

Request Example

TypeScript Gen
await client.shieldLists.updateShieldListByIdV2025R0(shieldListCountry.id, {
  name: shieldListCountryName,
  description: 'Updated description',
  content: new ShieldListContentCountryV2025R0({
    type: 'country' as ShieldListContentCountryV2025R0TypeField,
    countryCodes: ['US'],
  }),
} satisfies ShieldListsUpdateV2025R0);
Python Gen
client.shield_lists.update_shield_list_by_id_v2025_r0(
    shield_list_country.id,
    shield_list_country_name,
    ShieldListContentCountryV2025R0(
        type=ShieldListContentCountryV2025R0TypeField.COUNTRY, country_codes=["US"]
    ),
    description="Updated description",
)
.NET Gen
await client.ShieldLists.UpdateShieldListByIdV2025R0Async(shieldListId: shieldListCountry.Id, requestBody: new ShieldListsUpdateV2025R0(name: shieldListCountryName, content: new ShieldListContentCountryV2025R0(type: ShieldListContentCountryV2025R0TypeField.Country, countryCodes: Array.AsReadOnly(new [] {"US"}))) { Description = "Updated description" });

Response Example

{
  "id": "90fb0e17-c332-40ed-b4f9-fa8908fbbb24",
  "type": "shield_list",
  "content": {
    "type": "country",
    "country_codes": [
      "US",
      "PL"
    ]
  },
  "created_at": "2025-01-13T15:31:01.896Z",
  "description": "A list of things that are shielded",
  "enterprise": {
    "id": "1910967",
    "type": "enterprise"
  },
  "name": "Shield List Name",
  "updated_at": "2025-01-13T15:31:01.896Z"
}