Add the power of the Box AI API to your custom apps at Content Cloud Summit on May 15

Learn more and register!

Add changed status of shield information barrier with specified ID


Change status of shield information barrier with the specified ID.



Request Body

stringin bodyrequired

The ID of the shield information barrier.

stringin bodyrequired

The desired status for the shield information barrier.

Value is one of pending,disabled


Returns the updated shield information barrier object.

application/jsonClient error

Returns a not_found error if the shield information barrier was not found.

application/jsonClient error

Returns an error if there exists Conflicts with existing information barriers.

application/jsonClient error

An unexpected client error.

Add changed status of shield information barrier with specified ID
You can now try out some of our APIs live, right here in the documentation.
Log in

Request Example

const barrier = await client.shieldInformationBarriers.changeStatusById({
    id: 12345,
    status: 'pending',
    `Shield information barrier id ${} status is ${barrier.status}`
TypeScript (Beta)
await client.shieldInformationBarriers.updateShieldInformationBarrierStatus({
  id: barrierId,
    'disabled' as UpdateShieldInformationBarrierStatusRequestBodyStatusField,
} satisfies UpdateShieldInformationBarrierStatusRequestBody);
Python (Beta)
client.shield_information_barriers.update_shield_information_barrier_status(barrier_id, UpdateShieldInformationBarrierStatusStatus.DISABLED.value)
.NET (Beta)
await client.ShieldInformationBarriers.UpdateShieldInformationBarrierStatusAsync(requestBody: new UpdateShieldInformationBarrierStatusRequestBody(id: barrierId, status: UpdateShieldInformationBarrierStatusRequestBodyStatusField.Disabled));

Response Example

  "id": "11446498",
  "type": "shield_information_barrier",
  "created_at": "2020-06-26T18:44:45.869Z",
  "created_by": {
    "id": "11446498",
    "type": "user"
  "enabled_at": "2020-07-26T18:44:45.869Z",
  "enabled_by": {
    "id": "11446498",
    "type": "user"
  "enterprise": {
    "id": "1910967",
    "type": "enterprise"
  "status": "draft",
  "updated_at": "2020-07-26T18:44:45.869Z",
  "updated_by": {
    "id": "11446498",
    "type": "user"