<Info icon="fa-light fa-lock" className="permission-callout"> <div className="permission-callout__header"><span className="permission-callout__title"><span className="permission-callout__label">Required permissions</span> <span className="fern-docs-badge small blue subtle rounded-full permission-callout__beta">Beta</span></span> <span className="permission-callout__learn-more">[Learn more](/developers/api-guidelines/permissions#how-permissions-work)</span></div>

User.Invitation + Create

<div className="permission-callout__roles"><span className="permission-callout__roles-label">Roles:</span> <Badge intent="info">Administrator</Badge></div> </Info>

Invite a user to a Workspace by specifying username and the roles that the user will have in the organization. This user is created and a User invited event is sent. There is no additional action such as an email sent.

The following fields may be provided:

• username (String) - Email of the invited user
• name (String) - Name of the invited user
• organisation (Object) - Defaults to the default Workspace of the requesting user
• roles (Array) - Assigns the Administrator role by default

If the invited user doesn't exist, a new user is created and the organisation.id is their default Workspace. If the invited user already exists, the user is assigned to the Workspace. This fails if the Workspace feature isn't enabled on the target organization's tariff plan.