Skip to main content

Invite Members

Invites one or more new Members to the workspace.

Invite Members

Invites one or more people to become a Member in the current Workspace. Results in an invitation email being sent from SmartSuite. Requires Administrator permissions.

invite_member(invite: InviteRequest): Promise<void>;-
Parameter NameTypeDescription
inviteInviteRequest objectInvitation details

InviteRequest

An invitation request.

export interface InviteRequest extends InviteBase {
emails?: string[];
Parameter NameTypeDescription
emailsarray of stringsArray of email addresses for invitees

InviteBase

Base Invitation Object.

export interface InviteBase {
id?: ID;
invited_to?: string | number;
role: string;
type: string;
teams: ID[];
message?: string;
}
Parameter NameTypeDescription
idstringId of the member. Leave null for invite.
invited_tostringWorkspace Id to invite to.
rolenumber as stringRole to assign invited Member(s).
typenumber as stringMember type (employee, contractor etc.) for the invitees.
teamsarray of stringsTeam(s) to add the invited Member(s) to.
messagestring(optional) Customized invitation message to send with the invitation.
Invite Members

<!--invite_member(invite: InviteRequest): Promise<void>;-->

<script>
window.SmartSuite.invite_member(
{
"emails":["trubetskoi.andrii@outlook.com"],
"role":"1",
"type":"1",
"teams":["6728936b11ec1ac7888a91ef"],
"invited_to":"s9o23dmo"
}).then((res) => {
console.log('result =>>>', res);
});
</script>