Skip to main content
POST
/
shield_lists
cURL
curl --request POST \
  --url https://api.box.com/2.0/shield_lists \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'box-version: <box-version>' \
  --data '
{
  "name": "My Shield List",
  "content": {
    "type": "country",
    "country_codes": [
      "US",
      "PL"
    ]
  },
  "description": "A list of things that are shielded"
}
'
{
  "id": "90fb0e17-c332-40ed-b4f9-fa8908fbbb24",
  "type": "shield_list",
  "name": "Shield List Name",
  "enterprise": {
    "id": "1910967",
    "type": "enterprise"
  },
  "created_at": "2025-01-13T15:31:01.896Z",
  "updated_at": "2025-01-13T15:31:01.896Z",
  "content": {
    "type": "country",
    "country_codes": [
      "US",
      "PL"
    ]
  },
  "description": "A list of things that are shielded"
}
Learn more about Box SDK versioning strategy.

Authorizations

​
Authorization
string
header
required

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

Headers

​
box-version
enum<string>
required

Version header.

Available options:
2025.0

Body

application/json

The schema for Shield List create request.

​
name
string
required

The name of the shield list.

Example:

"My Shield List"

​
content
Shield List Content (Country) · object
required

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.

​
description
string

Optional description of Shield List.

Example:

"A list of things that are shielded"

Response

Returns the shield list object.

A standard representation of a Shield List.

​
id
string
required

Unique identifier for the shield list.

Example:

"90fb0e17-c332-40ed-b4f9-fa8908fbbb24"

​
type
string
required

Type of the object.

Example:

"shield_list"

​
name
string
required

Name of the shield list.

Example:

"Shield List Name"

​
enterprise
Enterprise reference · object
required

Enterprise for which this list belongs to.

​
created_at
string<date-time>
required

ISO date time string when this shield list object was created.

Example:

"2025-01-13T15:31:01.896Z"

​
updated_at
string<date-time>
required

ISO date time string when this shield list object was updated.

Example:

"2025-01-13T15:31:01.896Z"

​
content
Shield List Content (Country) · object
required

Specifies the type of elements in this Shield List and includes the elements themselves.

​
description
string

Description of Shield List.

Example:

"A list of things that are shielded"