メインコンテンツまでスキップ

UserInvite

ユーザーを招待する

Description​

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

Method​

POST

Request URL Format​

/api/v0/userinvite

Request URL Sample​

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

Sendgridをメールサービスに利用する(標準)​

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アドレスを任意の値に変更したい場合に指定します
    "sender_name": "Hexabase", // 招待メールを送信する際のfrom名前を任意の値に変更したい場合に指定します
    "invitation_path": "招待されたユーザーを確認するためのパス", // オプション (デフォルト： 'confirm_email')
    "email_templates_id" : "5fb205b03545feade82dxxxx",  // （任意）招待メールを送信する際にお客様用のSendgridテンプレートを使用する場合に設定します。事前にHexabase社へ必要事項を連絡し、Hexabase社より発行されたemail設定IDを指定します。 省略するとHexabaseのデフォルトのパスワード変更画面が利用されます。
}

Response Sample​

payloadで指定したユーザーが存在し、メールが送信された場合はstats: 200が返却されます

[
    {
        "email": "[email protected]",
        "stats": 200
    },
    {
        "email": "[email protected]",
        "stats": 200
    }
]
  • payloadで指定したユーザーが存在しない場合はstats: 400が返却されます
  • 特にワークスペース限定ユーザーを招待したい場合はexclusive_w_idの指定が必要になるためご留意ください
[
    {
        "email": "[email protected]",
        "stats": 400
    }
]

Sendgrid以外をメールサービスに利用する​

no_confirm_emailフラグを指定することで、標準の送信メールを送信しないよう設定できます。

Payload​

Content-Type : application/json

{
    "users": [
        {
            "email": "[email protected]"
        },
        {
            "email": "[email protected]",
            "exclusive_w_id": "624bea3a879f4e8d8b5dcc6c" // AddUserでワークスペース限定ユーザとして追加したい場合に同ワークスペースIDを指定します
        }
    ],
    "no_confirm_email": true // true指定でHexabase標準のSendgridメールが送信されなくなります
}

Response Sample​

  • no_confirm_email: trueとした場合、招待したユーザに対するconfirmation_idが返却されます
  • 返却されたconfirmation_idをRegisterUser で使用できます
[
    {
        "confirmation_id": "62rcbd9j0p0ejlnpna589lpfu5pj9u8wzd9oi5libsmpzq710gb4ekow6sikrlw2lpejax2b71dd3pxt67yy7qjz994ypcbg7xnl",
        "email": "[email protected]"
    },
    {
        "confirmation_id": "8c8buoxpyf0gqcyoxn2tb3czvnsbsud8ipcemh12e9cgslgu0mmcsnxfq0p4z9aat3dqagt4sttvb423fo3kdspvnckzs6ycgp1w",
        "email": "[email protected]"
    }
]