メールを送信する

チャレンジの詳細を指定のメールアドレスに送信します。多くの場合、保護者への同意リクエストの送信に使用します。チャレンジは事前に作成されている必要があります。このAPIは配信のみを行います。再送する場合はもう一度呼び出してください。

Authorization

api-key

AuthorizationBearer <token>

In: header

Optional header for Account System Products to perform cross-product age gate checks. The value must be the product ID of the target product within the same organization. The target product must not itself be an Account System Product.

Request Body

application/json

メールのリクエストを送信

TypeScript Definitions

Use the request body type in TypeScript.

challengeId*string

チャレンジのID

Match^[A-z0-9]{8}-[A-z0-9]{4}-[A-z0-9]{4}-[A-z0-9]{4}-[A-z0-9]{12}$

Formatuuid

email?string

親または保護者のメールアドレス。省略した場合、そのチャレンジに登録済みの保護者が使用されます。

Formatemail

locale?string

メールに使用するロケール（IETF BCP 47形式）。

Match^[A-Za-z]{2,3}(-[A-Za-z0-9]+)*$

Response Body

`application/json`

curl -X POST "https://example.com/challenge/send-email" \  -H "Content-Type: application/json" \  -d '{    "challengeId": "ae6d4729-af32-42ea-8ef2-ff46c7664802"  }'

{}

{  "error": "NOT_FOUND",  "errorMessage": "Challenge not found"}

メールを送信する

Authorization

Header Parameters

Request Body

Response Body

200application/json

400application/json

Example Not found

Example Invalid email

Example Email mismatch

Example Approver required

`application/json`

`application/json`