User

Activate account

Allows a register user to activate their account with token.

Path

PUT /user/activate-account/

Headers

FieldTypeDescription
Content-Typestringapplication/x-www-form-urlencoded

Params

FieldTypeDescription
activate_tokenstringToken to activate account.

Example

curl --location --request PUT 'https://www.example.com/api/user/activate-account/:activate_token' \
{
  "code": "ACTIVATED",
  "message": "Good job! Your account is now activated and you can start using WolfPal."
}

Resend Activate account

Allows a register user resend account activate token to their email.

Path

POST /user/activate-account/resend

Headers

FieldTypeDescription
Content-Typestringapplication/x-www-form-urlencoded

Body

FieldTypeDescription
emailstringEmail of current account.

Example

curl --location --request POST 'https://www.example.com/api/user/activate-account/:activate_token' \
{
  "code": "PENDING_CONFIRMATION",
  "message": "Please check your email address to complete the registration."
}

Forgot Password

Allows a register user to request a password reset email.

Path

POST /user/forgot-password

Headers

FieldTypeDescription
Content-Typestringapplication/x-www-form-urlencoded

Body

FieldTypeDescription
emailstringEmail of current account.

Example

curl --location --request POST 'https://www.example.com/api/user/forgot-password' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'email=user@mrdemonwolf.github.io' \
{
  "code": "PENDING_CONFIRMATION",
  "error": "An Email has been sent to demonwolf@demonwolfdev.com with further instructions on how to reset your password. Please check your email account."
}

Reset Password

Allows a register user to use password reset token to chaneg their password.

Path

POST /user/reset-password

Headers

FieldTypeDescription
Content-Typestringapplication/x-www-form-urlencoded

Params

FieldTypeDescription
reset_tokenstringToken to reset password.

Body

FieldTypeDescription
passwordstringNew password of current account.
comfirmPasswordstringComfirm new password of current account.

Example

curl --location --request POST 'https://www.example.com/api/user/reset-password/:reset_token' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'password=user@mrdemonwolf.github.io' \
--data-urlencode 'comfirmPassword=user@mrdemonwolf.github.io' \
{
  "code": "UPDATED",
  "error": "Your passsword has been updated.  Please try logging in with your new password."
}