Box Developer Documentation
Log in
Latest version

Add changed status of shield information barrier with specified ID

post
https://api.box.com/2.0
/shield_information_barriers/change_status

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

Change status of shield information barrier with the specified ID.

Request

bearer [ACCESS_TOKEN]
application/json

Request Body

stringin bodyrequired
"1910967"

The ID of the shield information barrier.

stringin bodyrequired
"pending"

The desired status for the shield information barrier.

Value is one of pending,disabled

Response

application/jsonShield information barrier

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.

post
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

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

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"
  }
}