Sign in

v1

latestOpenAPI 3.0.2Apache-2.02026-07-142963051.0 MB
Invites

Create user invite

Invites an existing external user to join an enterprise.

The existing user can not be part of another enterprise and must already have a Box account. Once invited, the user will receive an email and are prompted to accept the invitation within the Box web application.

This method requires the "Manage An Enterprise" scope enabled for the application, which can be enabled within the developer console.

post/invites

Query parameters

fieldsstring[]

A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response.

Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.

Request body

Example request

{
  "enterprise": {
    "id": "1232234"
  },
  "actionable_by": {
    "login": "john@example.com"
  }
}

Response

Returns a new invite object.

idstring required

The unique identifier for this invite.

type'invite' required

The value will always be invite.

statusstring

The status of the invite.

created_atstring date-time

When the invite was created.

modified_atstring date-time

When the invite was modified.

Example response

{
  "id": "11446498",
  "type": "invite",
  "invited_to": {
    "id": "11446498",
    "type": "enterprise",
    "name": "Acme Inc."
  },
  "actionable_by": {
    "id": "11446498",
    "type": "user",
    "name": "Aaron Levie",
    "login": "ceo@example.com"
  },
  "invited_by": {
    "id": "11446498",
    "type": "user",
    "name": "Aaron Levie",
    "login": "ceo@example.com"
  },
  "status": "pending",
  "created_at": "2012-12-12T10:53:43-08:00",
  "modified_at": "2012-12-12T10:53:43-08:00"
}