Last modified: 2024-04-19

REST API

To download the full code sample see our Code Share site. For information on how to reset a sender password using the application see Managing Senders. For more information on the default password settings, see Security Settings.

If an account user forgets their password, the account manager can send a password-reset email to the member’s email address.

The Code

To send the reset-password email, you will need to the following:

  • Find the Sender ID for the user.
  • Send the password reset email.

Finding the Sender ID

You can search for a user's Sender ID using the following API request. The search is done using the user’s First Name, Last Name, or Email Address.

HTTP Request

GET /api/account/senders?from=1&to=100&search={fisrtName/lastName/Email}

HTTP Headers

Accept: application/json
Content-Type: application/json
Authorization: Basic api_key

Response Payload

{
  "results": [
    {
      "address": null,
      "company": "your_compnay_name",
      "timezoneId": "EST",
      "created": "2019-07-30T15:52:49Z",
      "email": "[email protected]",
      "external": null,
      "firstName": "Mary",
      "language": "en",
      "lastName": "Doe",
      "phone": "",
      "professionalIdentityFields": [],
      "signature": null,
      "title": null,
      "updated": "2019-07-30T15:52:49Z",
      "userCustomFields": [],
      "specialTypes": [],
      "passwordTimestamp": null,
      "id": "IkV7ykSic6EU",
      "status": "ACTIVE",
      "locked": null,
      "memberships": [],
      "activated": null,
      "account": {...},
      "name": "",
      "type": "REGULAR",
      "data": {...},
      "hasDelegates": false
    }
  ],
  "count": 1
}

The "search" parameter is used to filter search results. Only users whose First Name, Last Name or Email Address match this string will be listed. A Wildcard search will be performed by default. For example, if you search for "@example.com", all senders with this email domain will be returned. The “id” attribute is what you need to retrieve in the response payload.

Sending the Reset Password Email

After you have retrieved your user's Sender ID, you can send them an email to reset their password by using the following API request.

HTTP Request

POST /api/account/senders/{senderId}/resetpassword

HTTP Headers

Accept: application/json
Content-Type: application/json
Authorization: Basic api_key

Results

After running your code, your sender will receive an email with instructions on how to reset their password.

Was this information helpful?
X