Skip to main content

UserInvite

UserInvite

ユーザーを招待

Description

  • ワークスペースへ未招待のユーザーを招待します。
  • このAPIを実行する前に、AddUser APIでワークスペースへユーザーを追加する必要があります。
  • システムに固有のSendgridメールテンプレートを利用する場合は、事前にHexabase社へ必要事項を連絡します。Hexabase社より発行されたemail_templates_idを指定することで、独自のSendgridメールテンプレートを利用することができます。

Method

POST

Request URL Format

/api/v0/userinvite

Payload

Content-Type : application/json

{
"users": [
{
"email": "[email protected]"
},
{
"email": "[email protected]",
"exclusive_w_id": "624bea3a879f4e8d8b5dcc6c" // AddUserでワークスペース限定ユーザとして追加したい場合に同ワークスペースIDを指定します
}
],
"domain": "app.xxx.com",
"sender_address": "[email protected]" // 招待メールを送信する際のfromを任意の値に変更したい場合に指定します
"invitation_path": "招待されたユーザーを確認するためのパス", // オプション (デフォルト: 'confirm_email')
"email_templates_id" : "5fb205b03545feade82dxxxx", // (任意)招待メールを送信する際にお客様用のSendgridテンプレートを使用する場合に設定します。事前にHexabase社へ必要事項を連絡し、Hexabase社より発行されたemail設定IDを指定します。 省略するとHexabaseのデフォルトのパスワード変更画面が利用されます。
}

Request URL Sample

POST https://api.xxx.com/api/v0/userinvite

Response Sample

[
{
"email": "[email protected]",
"stats": 200
},
{
"email": "[email protected]",
"stats": 200
}
]