Create shield information barrier segment

Creates a shield information barrier segment.

POST /shield_information_barrier_segments

cURL

cURL

curl --request POST \
  --url https://api.box.com/2.0/shield_information_barrier_segments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data @- <<EOF
{
  "shield_information_barrier": {
    "id": "11446498",
    "type": "shield_information_barrier"
  },
  "name": "Investment Banking",
  "description": "'Corporate division that engages in\n advisory_based financial\ntransactions on behalf of individuals,\ncorporations, and governments.'"
}
EOF

201

{
  "id": "11446498",
  "type": "shield_information_barrier_segment",
  "shield_information_barrier": {
    "id": "11446498",
    "type": "shield_information_barrier"
  },
  "name": "Investment Banking",
  "description": "'Corporate division that engages in advisory_based financial\n transactions on behalf of individuals, corporations, and governments.'",
  "created_at": "2020-06-26T18:44:45.869Z",
  "created_by": {
    "id": "11446498",
    "type": "user"
  },
  "updated_at": "2020-07-26T18:44:45.869Z",
  "updated_by": {
    "id": "11446498",
    "type": "user"
  }
}

This endpoint is in the version 2024.0. No changes are required to continue using it. For more details, see Box API versioning.

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.

Body

application/json

shield_information_barrier · Shield information barrier (Base) · object · required

A base representation of a shield information barrier object.

Show child attributes

name · string · required

Name of the shield information barrier segment.

Example:

"Investment Banking"

description · string

Description of the shield information barrier segment.

Example:

"'Corporate division that engages in\n advisory_based financial\ntransactions on behalf of individuals,\ncorporations, and governments.'"

Response

201

application/json

Returns a new shield information barrier segment object.

A shield information barrier segment object.

id · string

The unique identifier for the shield information barrier segment.

Example:

"11446498"

type · enum<string>

The type of the shield information barrier segment.

Available options: shield_information_barrier_segment

Example:

"shield_information_barrier_segment"

shield_information_barrier · Shield information barrier (Base) · object

A base representation of a shield information barrier object.

Show child attributes

name · string

Name of the shield information barrier segment.

Example:

"Investment Banking"

description · string

Description of the shield information barrier segment.

Example:

"'Corporate division that engages in advisory_based financial\n transactions on behalf of individuals, corporations, and governments.'"

created_at · string<date-time>

ISO date time string when this shield information barrier object was created.

Example:

"2020-06-26T18:44:45.869Z"

created_by · User (Base) · object

The user who created this shield information barrier segment.

Show child attributes

updated_at · string<date-time>

ISO date time string when this shield information barrier segment was updated.

Example:

"2020-07-26T18:44:45.869Z"

updated_by · User (Base) · object

The user that updated this shield information barrier segment.

Show child attributes