BObox
Domain restrictions for collaborations

Add domain to list of allowed collaboration domains

Changed on

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

post/collaboration_whitelist_entries

Request

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

Request body

domainstring required

The domain to add to the list of allowed domains.

direction'inbound' | 'outbound' | 'both' required

The direction in which to allow collaborations.

Example request

{
  "domain": "example.com",
  "direction": "inbound"
}

Response

Returns a new entry on the list of allowed domains.

idstring

The unique identifier for this entry.

type'collaboration_whitelist_entry'

The value will always be collaboration_whitelist_entry.

domainstring

The whitelisted domain.

direction'inbound' | 'outbound' | 'both'

The direction of the collaborations to allow.

created_atstring date-time

The time the entry was created at.

Example response

{
  "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"
}

Changes

  • c4d5303fa5c3Revision changes
    • warning

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