Password Setup Request for Accounts

You can send a password setup request to the email address that is registered to an account.

You can send the email with the password setup request in either of the following cases:

A new account has been created.
No password has been set after changing an email address.

An error occurs in the following cases:

The email address does not exist (the destination cannot be confirmed or the email cannot be delivered).
The request has been rejected by the recipient.

As an operational restriction, after you send an email of the setup request via this API, resending of the email cannot be processed for a certain period and an error occurs.

(Current duration of resending restriction: 600 seconds)

Request Interface

HTTP Request

POST /accounts/password/set-request

Parameter

Request Parameter	Value	Required	Description	Default Value
accountId	string	true	ID that uniquely distinguishes the account (32 alphabet characters)	-

Response Interface

If the request is processed successfully, the response body is not returned.

Examples

Java JavaScript

public static void main(String[] args) {
    String host = "https://www.webconnect.hulft.com";
    String apiKey = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx";
    try {
        URL url = new URL(host + "/api/v2/accounts/password/set-request");
        HttpURLConnection connection = (HttpURLConnection) url.openConnection();
        String postData = "{\"accountId\": \"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\"}";
        connection.setRequestMethod("POST");
        connection.setDoOutput(true);
        connection.setDoInput(true);
        connection.setRequestProperty("Authorization", "Bearer " + apiKey);
        connection.setRequestProperty("Content-Type", "application/json");
        connection.setRequestProperty("Content-Length", Integer.toString(postData.length()));
        try (BufferedWriter writer = 
		new BufferedWriter(new OutputStreamWriter(connection.getOutputStream()))) {
        	writer.write(postData);
        }
        System.out.println(connection.getResponseMessage()); 
			// The response does not contain the response body.
    } catch (IOException ex) {
        // error
    }
}

// load jquery 
var host = 'https://www.webconnect.hulft.com';
var apiKey = 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx';
$.ajax({
  type: 'POST',
  url: host + '/api/v2/accounts/password/set-request',
  headers: {
    Authorization: 'Bearer ' + apiKey
  },
  contentType: 'application/json',
  data: JSON.stringify({
  "accountId": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
  })
}).done(function(data, status, xhr) {
  console.log(data);
}).fail(function(data, status, xhr) {
  console.log(data);
});