Skip to main content
POST
/
invites
cURL
curl -i -X POST "https://api.box.com/2.0/invites" \
     -H "authorization: Bearer <ACCESS_TOKEN>" \
     -H "content-type: application/json" \
     -d '{
       "enterprise": {
         "id": "1232234"
       },
       "actionable_by": {
         "login" : "[email protected]"
       }
     }'
{
  "id": "11446498",
  "type": "invite",
  "invited_to": {
    "id": "11446498",
    "type": "enterprise",
    "name": "Acme Inc."
  },
  "actionable_by": {
    "id": "11446498",
    "type": "user",
    "name": "Aaron Levie",
    "login": "[email protected]"
  },
  "invited_by": {
    "id": "11446498",
    "type": "user",
    "name": "Aaron Levie",
    "login": "[email protected]"
  },
  "status": "pending",
  "created_at": "2012-12-12T10:53:43-08:00",
  "modified_at": "2012-12-12T10:53:43-08:00"
}
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.

Query Parameters

​
fields
string[]

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.

Body

application/json
​
enterprise
object
required

The enterprise to invite the user to.

​
actionable_by
object
required

The user to invite.

Response

Returns a new invite object.

An invite for a user to an enterprise.

​
id
string
required

The unique identifier for this invite.

Example:

"11446498"

​
type
enum<string>
required

The value will always be invite.

Available options:
invite
Example:

"invite"

​
invited_to
Enterprise · object

A representation of a Box enterprise.

​
actionable_by
User (Mini) · object

A mini representation of a user, as can be returned when nested within other resources.

​
invited_by
User (Mini) · object

A mini representation of a user, as can be returned when nested within other resources.

​
status
string

The status of the invite.

Example:

"pending"

​
created_at
string<date-time>

When the invite was created.

Example:

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

​
modified_at
string<date-time>

When the invite was modified.

Example:

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