Sample - Box Platform API
POST/collaboration_whitelist_entries

Add domain to list of allowed collaboration domains

Creates a new entry in the list of allowed domains to allow collaboration for.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

2 body fields
domainstringrequired
The domain to add to the list of allowed domains.
directionstringrequired
The direction in which to allow collaborations.
Allowed:inboundoutboundboth

2 status codes
200Returns a new entry on the list of allowed domains.
idstringoptional
The unique identifier for this entry.
typestringoptional
The value will always be `collaboration_whitelist_entry`.
Allowed:collaboration_whitelist_entry
domainstringoptional
The whitelisted domain.
directionstringoptional
The direction of the collaborations to allow.
Allowed:inboundoutboundboth
enterpriseobjectoptional
created_atstringoptional
The time the entry was created at.
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

Any other status is an error: An unexpected client error.