Verification

Endpoints associated with creating and managing user accounts.

Download OpenAPI description
Languages
Servers
https://rest.clicksend.com/

Forgot Username

Request

Forgot username

Requires the user to pass either the email registered to an account or the phone number, not both

Properties

NameTypeRequiredRestrictionsDescription
emailstringtruenoneEmail belonging to account
phone_numberstringtruenonePhone belonging to account

Refer to Status Codes for definitions of HTTP status code responses.

This endpoint does not require authentication
Headers
Content-Typestring
Example: application/json
Bodyapplication/json
emailstring
Example: "test@test.com"
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'

Responses

Successful response

Bodyapplication/json
http_codeinteger

The HTTP status code of the response.

Example: 200
response_codestring

The response code indicating the status of the operation.

Example: "SUCCESS"
response_msgstring

A message describing the outcome of the operation.

Example: "An email notification has been sent."
dataArray of items
Example: []
Response
application/json
{ "http_code": 200, "response_code": "SUCCESS", "response_msg": "An email notification has been sent.", "data": [] }

Forgot Password

Request

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.

Properties

NameTypeRequiredRestrictionsDescription
usernamestringtruenoneUsername belonging to account

Refer to Status Codes for definitions of HTTP status code responses.

This endpoint does not require authentication
Headers
Content-Typestring
Example: application/json
Bodyapplication/json
usernamestring
Example: "test"
curl --include \
     --request PUT \
     --header "Content-Type: application/json" \
     --data-binary "    {
        \"username\": \"0F6pKiiuca\"
    }" \
'https://rest.clicksend.com/v3/forgot-password'

Responses

Successful response

Bodyapplication/json
http_codeinteger

The HTTP status code of the response.

Example: 200
response_codestring

The response code indicating the status of the operation.

Example: "SUCCESS"
response_msgstring

A message describing the outcome of the operation.

Example: "An email notification has been sent."
dataArray of items
Example: []
Response
application/json
{ "http_code": 200, "response_code": "SUCCESS", "response_msg": "An email notification has been sent.", "data": [] }