Skip to main content

Email

Definition​

Email Type
email.json
{
  "id": 0,
  "userID": 0,
  "emailAddress": "",
  "emailVerifiedAt": "",
  "status": 0,
  "createdAt": "",
  "updatedAt": "",
}

Get Emails​

curl -X GET "https://${baseUrl}/email/?\$filter=&\$orderBy=&\$page=1&\$pageSize=10" \
   -H "Authorization: Bearer ${accessToken}" \
   -H "Content-Type: application/json" \
   -H "Accept: application/json"

Get Email​

curl -X GET "https://${baseUrl}/email/${id}" \
   -H "Authorization: Bearer ${accessToken}" \
   -H "Content-Type: application/json" \
   -H "Accept: application/json"

Apply Email.ID​

curl -X POST "https://${baseUrl}/apply/email/id/" \
   -H "Authorization: Bearer ${accessToken}" \
   -H "Content-Type: application/json" \
   -H "Accept: application/json"

Create Email​

curl -X POST "https://${baseUrl}/email/" \
   -H "Authorization: Bearer ${accessToken}" \
   -H "Content-Type: application/json" \
   -H "Accept: application/json" \
   -d @email.json
info
email.json
{
  "userID": 0,
  "emailAddress": "",
  "emailVerifiedAt": "",
  "status": 0,
}
tip

success status: 201

Update Email​

curl -X PUT "https://${baseUrl}/email/${id}" \
   -H "Authorization: Bearer ${accessToken}" \
   -H "Content-Type: application/json" \
   -H "Accept: application/json" \
   -d @email.json
info
email.json
{
  "userID": 0,
  "emailAddress": "",
  "emailVerifiedAt": "",
  "status": 0,
}

Update Email Partial​

curl -X PATCH "https://${baseUrl}/email/${id}" \
   -H "Authorization: Bearer ${accessToken}" \
   -H "Content-Type: application/json" \
   -H "Accept: application/json" \
   -H "Attrs: userID,emailAddress,emailVerifiedAt,status" \
   -d @email.json
info
email.json
{
  "userID": 0,
  "emailAddress": "",
  "emailVerifiedAt": "",
  "status": 0,
}

Update Email Status​

curl -X PATCH "https://${baseUrl}/email/${id}/status/" \
   -H "Authorization: Bearer ${accessToken}" \
   -H "Content-Type: application/json" \
   -H "Accept: application/json" \
   -d @email.json
info
email.json
{
  "status": 0
}

Destroy Email​

curl -X DELETE "https://${baseUrl}/email/${id}" \
   -H "Authorization: Bearer ${accessToken}" \
   -H "Content-Type: application/json" \
   -H "Accept: application/json"