BObox
Shield information barriers

Add changed status of shield information barrier with specified ID

Changed on

Change status of shield information barrier with the specified ID.

post/shield_information_barriers/change_status

Request

  • Base URL
    https://api.box.com/2.0
  • URL
    https://api.box.com/2.0/shield_information_barriers/change_status
  • Auth
    OAuth 2
    Authorization code: https://account.box.com/api/oauth2/authorize
    Token URL: https://api.box.com/oauth2/token

Request body

idstring required

The ID of the shield information barrier.

status'pending' | 'disabled' required

The desired status for the shield information barrier.

Example request

{
  "id": "1910967",
  "status": "pending"
}

Response

Returns the updated shield information barrier object.

idstring

The unique identifier for the shield information barrier.

type'shield_information_barrier'

The type of the shield information barrier.

status'draft' | 'pending' | 'disabled' | 'enabled' | 'invalid'

Status of the shield information barrier.

created_atstring date-time

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

updated_atstring date-time

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

enabled_atstring date-time

ISO date time string when this shield information barrier was enabled.

Example response

{
  "id": "11446498",
  "type": "shield_information_barrier",
  "enterprise": {
    "id": "1910967",
    "type": "enterprise"
  },
  "status": "draft",
  "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"
  },
  "enabled_at": "2020-07-26T18:44:45.869Z",
  "enabled_by": {
    "id": "11446498",
    "type": "user"
  }
}

Changes

  • c4d5303fa5c3Revision changes
    • warning

      added the new unprocessable_entity enum value to the response property for the response status

    • warning

      added the new unprocessable_entity enum value to the response property for the response status

    • warning

      added the new unprocessable_entity enum value to the response property for the response status