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

Invite User

既存のユーザーが新規ユーザーを招待するためのAPIです。既存のユーザーは新規ユーザーのメールアドレスを指定し、そのアドレス宛にアカウント本登録の案内メールを送信します。本登録は /signup/confirm を使用します。メール本文には、本登録のためのURLと確認番号が記載されていますので、ご確認ください。

Header Parameters
Authentication string REQUIRED

NewtZeroのアカウントで発行されるAPIキーです。

Request Body REQUIRED
email string REQUIRED

招待するユーザーのメールアドレスです。このメールアドレスがアカウントのメールアドレスとして登録されます。

customInviteUrl string

アカウントの招待メールに記載されるURLを指定できます。このURLはアカウントの本登録を行うためのものです。

Responses
200

メールの招待に成功しました。

400

送信したデータが無効な場合に400エラーを返します。