Update shield information barrier segment with specified ID

put

https://api.box.com/2.0

/shield_information_barrier_segments/:shield_information_barrier_segment_id

Updates the shield information barrier segment based on provided ID..

Request

authorizationbearer [ACCESS_TOKEN]

content-typeapplication/json

Path Parameters

shield_information_barrier_segment_id stringin pathrequired

example"3423"

The ID of the shield information barrier segment.

Request Body

description stringin bodyoptional

example

"'Corporate division that engages in advisory_based\nfinancial transactions on behalf of individuals,\ncorporations, and governments.'"

The updated description for the shield information barrier segment.

name stringin bodyoptional

pattern\S+example"Investment Banking"

The updated name for the shield information barrier segment.

Response

200application/jsonShield information barrier segment

Returns the updated shield information barrier segment object.

404application/jsonClient error

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

409application/jsonClient error

Returns an error if there exists a shield information Barrier Segment with the same name.

defaultapplication/jsonClient error

An unexpected client error.

put

Update shield information barrier segment with specified ID

You can now try out some of our APIs live, right here in the documentation.

Request Example

Node

const barrierSegment = await client.shieldInformationBarrierSegments.update({
	name: 'updated name',
	description: 'updated description',
}, {
	shield_information_barrier_segment_id: '12345'
});
console.log(`Shield information barrier segment id ${barrierSegment.id} updated`);

Response Example

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