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 Name | Type | Description |
---|---|---|
invite | InviteRequest object | Invitation details |
InviteRequest
An invitation request.
export interface InviteRequest extends InviteBase {
emails?: string[];
Parameter Name | Type | Description |
---|---|---|
emails | array of strings | Array 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 Name | Type | Description |
---|---|---|
id | string | Id of the member. Leave null for invite. |
invited_to | string | Workspace Id to invite to. |
role | number as string | Role to assign invited Member(s). |
type | number as string | Member type (employee, contractor etc.) for the invitees. |
teams | array of strings | Team(s) to add the invited Member(s) to. |
message | string | (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>