Sample - Box Platform API
POST/shield_information_barrier_segment_restrictions

Create shield information barrier segment restriction

Creates a shield information barrier segment restriction object.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

4 body fields
typestringrequired
The type of the shield barrier segment restriction for this member.
Allowed:shield_information_barrier_segment_restriction
shield_information_barrierobjectoptional
A base representation of a shield information barrier object.
shield_information_barrier_segmentobjectrequired
The `type` and `id` of the requested shield information barrier segment.
restricted_segmentobjectrequired
The `type` and `id` of the restricted shield information barrier segment.

3 status codes
201Returns the newly created Shield Information Barrier Segment Restriction object.
typestringoptional
Shield information barrier segment restriction.
Allowed:shield_information_barrier_segment_restriction
idstringoptional
The unique identifier for the shield information barrier segment restriction.
shield_information_barrier_segmentobjectrequired
The `type` and `id` of the requested shield information barrier segment.
restricted_segmentobjectrequired
The `type` and `id` of the restricted shield information barrier segment.
shield_information_barrierobjectoptional
A base representation of a shield information barrier object.
created_atstringoptional
ISO date time string when this shield information barrier Segment Restriction object was created.
created_byobjectoptional
updated_atstringoptional
ISO date time string when this shield information barrier segment Restriction was updated.
updated_byobjectoptional
404Returns a `not_found` error if the shield information barrier or segment was not found.
typestringoptional
The value will always be `error`.
Allowed:error
statusintegeroptional
The HTTP status of the response.
codestringoptional
A Box-specific error code.
Allowed:createdacceptedno_contentredirectnot_modifiedbad_requestunauthorizedforbiddennot_foundmethod_not_allowedconflictprecondition_failed
messagestringoptional
A short message describing the error.
context_infoobjectoptional
A free-form object that contains additional context about the error. The possible fields are defined on a per-endpoint basis. `message` is only one example.
help_urlstringoptional
A URL that links to more information about why this error occurred.
request_idstringoptional
A unique identifier for this response, which can be used when contacting Box support.
defaultAn unexpected client error.
typestringoptional
The value will always be `error`.
Allowed:error
statusintegeroptional
The HTTP status of the response.
codestringoptional
A Box-specific error code.
Allowed:createdacceptedno_contentredirectnot_modifiedbad_requestunauthorizedforbiddennot_foundmethod_not_allowedconflictprecondition_failed
messagestringoptional
A short message describing the error.
context_infoobjectoptional
A free-form object that contains additional context about the error. The possible fields are defined on a per-endpoint basis. `message` is only one example.
help_urlstringoptional
A URL that links to more information about why this error occurred.
request_idstringoptional
A unique identifier for this response, which can be used when contacting Box support.

Error handling

A 404 is returned: Returns a not_found error if the shield information barrier or segment was not found. Any other status is an error: An unexpected client error.