There's a new version of the HubSpot API

Check out the new API
View Beta Docs

We're also working on a new documentation website, you're invited to check it out and give us your feedback.

SMTP API Tokens - Password Reset

Last updated July 22, 2024

POST /email/public/v1/smtpapi/tokens/:userName/password-reset

Method Details

HTTP Methods:

POST

Response Format:

JSON

Requires Authentication?

Yes

Rate Limited?

Yes

Required Scope

transactional-email

Once you have an SMTP API, the List SMTP API Tokens endpoint can be used to list all SMTP API Tokens in the portal. However, for security reasons the password is only provided during the time of the token creation. This endpoint allows for the creation of a replacement password for a given Token, keyed by the userName field. Once the password is successfully reset, the old password for the token will be invalid.

Note that use of API requires the Transactional Email add-on.

Required Parameters How to use Description
OAuth Access Token Authorization: Bearer {token}
Used in the request headers

Used to authenticate the request. Please see this page for more details about authentication.
userName Used in the request URL The userName field of the SMTP API Token needing a password reset.

Example

Example URL: POST https://api.hubapi.com/email/public/v1/smtpapi/tokens/zh48wgsfld%4062515.smtp.hubspot.net/password-reset

Example JSON Response

{
  "portalId": 62515,
  "userName": "aezckvh3hx@62515.smtp.hubspot.net",
  "password": "ItUuCc8h4I5MihiysY8HB6XSbWZmVZ",
  "passwordHash": null,
  "emailCampaignId": 14860979,
  "createdAt": 1415740569008,
  "deleted": false,
  "createdBy": "demo@hubspot.com",
  "appId": 22709,
  "campaignName": "test transactional email"
}

SMTP API

After resetting the password for the token above, you can use SMTP to send an email:
  • SMTP Hostname: smtp.hubapi.com
  • SMTP Port: 587 (for STARTTLS) or 465 for TLS
  • SMTP User Name: hrfdvt58el@62515.smtp.hubspot.net
  • SMTP Password: 3432fff8eljl1249fjjasdfnv3

About

Jobs

Learn Inbound

Support

Locations

HubSpot, Inc.
25 First Street, 2nd Floor
Cambridge, MA 02141
European Headquarters
Ground Floor, Two Dockland Central
Guild Street, Dublin 1
Asia/Pacific Office
20 Hunter St, Level 7
Sydney NSW 2000
View our other locations
{ "portalId": 62515, "userName": "aezckvh3hx@62515.smtp.hubspot.net", "password": "ItUuCc8h4I5MihiysY8HB6XSbWZmVZ", "passwordHash": null, "emailCampaignId": 14860979, "createdAt": 1415740569008, "deleted": false, "createdBy": "demo@hubspot.com", "appId": 22709, "campaignName": "test transactional email" }
import requests import urllib # Password reset def reset_smtp_api_token(user_name, **params): if not ( params.get('access_token')): raise Exception("Expecting access_token") r = requests.post("https://api.hubapi.com/email/public/v1/smtpapi/tokens/{0}/password-reset?{1}".format( urllib.quote(user_name), urllib.urlencode(params) )) if 200 <= r.status_code < 300: return r.json() else: raise Exception("Unknown error with HubSpot API: code:{0}, response:{1}".format(r.status_code, r.content)) smtp_api_token = reset_smtp_api_token("hrfdvt58el@62515.smtp.hubspot.net", accesstoken='demo') print smtp_api_token
$ curl -XPOST https://api.hubapi.com/email/public/v1/aezckvh3hx%4062515.smtp.hubspot.net/password-reset?hapikey=demo { "portalId": 62515, "userName": "aezckvh3hx@62515.smtp.hubspot.net", "password": "ItUuCc8h4I5MihiysY8HB6XSbWZmVZ", "passwordHash": null, "emailCampaignId": 14860979, "createdAt": 1415740569008, "deleted": false, "createdBy": "demo@hubspot.com", "appId": 22709, "campaignName": "test transactional email" }