Skip to main content
POST
/
collaboration_whitelist_entries
cURL
curl -i -X POST "https://api.box.com/2.0/collaboration_whitelist_entries" \
     -H "authorization: Bearer <ACCESS_TOKEN>" \
     -H "content-type: application/json" \
     -d '{
       "domain": "example.com",
       "direction": "inbound"
     }'
{
  "id": "11446498",
  "type": "collaboration_whitelist_entry",
  "domain": "example.com",
  "direction": "both",
  "enterprise": {
    "id": "11446498",
    "type": "enterprise",
    "name": "Acme Inc."
  },
  "created_at": "2012-12-12T10:53:43-08:00"
}

Documentation Index

Fetch the complete documentation index at: https://developer.box.com/llms.txt

Use this file to discover all available pages before exploring further.

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

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json
​
domain
string
required

The domain to add to the list of allowed domains.

Example:

"example.com"

​
direction
enum<string>
required

The direction in which to allow collaborations.

Available options:
inbound,
outbound,
both
Example:

"inbound"

Response

Returns a new entry on the list of allowed domains.

An entry that describes an approved domain for which users can collaborate with files and folders in your enterprise or vice versa.

​
id
string

The unique identifier for this entry.

Example:

"11446498"

​
type
enum<string>

The value will always be collaboration_whitelist_entry.

Available options:
collaboration_whitelist_entry
Example:

"collaboration_whitelist_entry"

​
domain
string

The whitelisted domain.

Example:

"example.com"

​
direction
enum<string>

The direction of the collaborations to allow.

Available options:
inbound,
outbound,
both
Example:

"both"

​
enterprise
Enterprise · object

The enterprise this list is applied to.

​
created_at
string<date-time>

The time the entry was created at.

Example:

"2012-12-12T10:53:43-08:00"