Endpoints associated with creating and managing user accounts.
Endpoints associated with creating and managing user accounts.
Forgot username
Requires the user to pass either the email registered to an account or the phone number, not both
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
string | true | none | Email belonging to account | |
phone_number | string | true | none | Phone belonging to account |
Refer to Status Codes for definitions of HTTP status code responses.
curl --include \
--request PUT \
--header "Content-Type: application/json" \
--data-binary " {
\"phone_number\": \"3108147982\",
\"email\": \"test@email.com\"
}" \
'https://rest.clicksend.com/v3/forgot-username'
{ "http_code": 200, "response_code": "SUCCESS", "response_msg": "An email notification has been sent.", "data": [] }
Forgot password
A user can send their username to this endpoint to be sent an email with their registered email address that will have a verification code.
Once you have this verification email containing the code you can send it to the forgotten-password/verify endpoint along with a new password and the ID of that subaccount.
Ask your administrator if you do not know your subaccount id.
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
username | string | true | none | Username belonging to account |
Refer to Status Codes for definitions of HTTP status code responses.
curl --include \
--request PUT \
--header "Content-Type: application/json" \
--data-binary " {
\"username\": \"0F6pKiiuca\"
}" \
'https://rest.clicksend.com/v3/forgot-password'
{ "http_code": 200, "response_code": "SUCCESS", "response_msg": "An email notification has been sent.", "data": [] }