ユーザーを招待

指定したメールアドレスに、ワークスペースへの参加招待メールを送信します。ユーザーがアカウントを持っていない場合は、作成を求められます。ユーザーがこの招待を承諾すると、シートの1つを使用してワークスペースおよびサブスクリプションにユーザーとして追加されます。このエンドポイントを呼び出せるのは、WORKSPACE_MEMBERS_INVITE権限を持つワークスペースメンバーのみです。ユーザーがすでにワークスペースに所属している場合は、400エラーが返されます。

ヘッダー

xi-api-keystringオプション

リクエスト

This endpoint expects an object.
emailstring必須

顧客のメールアドレス

seat_typeenum or nullオプション

ユーザーのシートタイプ

許可された値:
group_idslist of strings or nullオプション

ユーザーのグループID

usage_limitinteger or nullオプション>=0

招待対象者の月間クレジット使用上限。カスタム上限を設けない場合は、省略するかnullに設定します。

workspace_permissionstring or nullオプションDeprecated

ユーザーのワークスペース権限です。これは非推奨です。代わりにseat_typeを使用してください。

レスポンス

成功レスポンス。

statusstring

ワークスペース招待リクエストのステータス。リクエストが成功した場合、ステータスは「ok」になります。それ以外の場合は、ステータス500のエラーメッセージが返されます。

エラー

422
Unprocessable Entity Error