이메일 보내기

챌린지의 세부 정보를 수신자에게 이메일로 발송합니다. 대부분 보호자에게 보내는 동의 요청에 사용됩니다. 챌린지는 이미 존재해야 하며, 이 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`