Skip to content

invites.md

Latest commit

 

History

History
79 lines (53 loc) · 2.06 KB

invites.md

File metadata and controls

79 lines (53 loc) · 2.06 KB
Raw

InvitesManager

Create user invite

Invites an existing external user to join an enterprise.

The user must already have a Box account and cannot be part of another enterprise. Once invited, the user receives an email and is prompted to accept the invitation in the Box web application.

If is_auto_roll_in_enabled is set to true, the user does not have to accept the invitation and is added to the enterprise automatically after 14 days. Only unmanaged users can be invited this way. An unmanaged user is a free user whose email domain matches one of the enterprise's domains. Availability depends on the enterprise's plan.

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

This operation is performed by calling function createInvite.

See the endpoint docs at API Reference.

await client.invites.createInvite({
  enterprise: {
    id: currentUser.enterprise!.id!,
  } satisfies CreateInviteRequestBodyEnterpriseField,
  actionableBy: {
    login: email,
  } satisfies CreateInviteRequestBodyActionableByField,
} satisfies CreateInviteRequestBody);

Arguments

  • requestBody CreateInviteRequestBody
    • Request body of createInvite method
  • optionalsInput CreateInviteOptionalsInput

Returns

This function returns a value of type Invite.

Returns a new invite object.

Get user invite status

Returns the status of a user invite.

This operation is performed by calling function getInviteById.

See the endpoint docs at API Reference.

await client.invites.getInviteById(invitation.id);

Arguments

  • inviteId string
    • The ID of an invite. Example: "213723"
  • optionalsInput GetInviteByIdOptionalsInput

Returns

This function returns a value of type Invite.

Returns an invite object.