There's a new version of the HubSpot API
We're also working on a new documentation website, you're invited to check it out and give us your feedback.
HTTP Methods:
POST
Request Format:
JSON
Response Format:
JSON
Requires Authentication?
Yes
Rate Limited?
Required Scope
This endpoint is used to create an SMTP API Token. An API token provides both a username and password which can then be used to send email through the HubSpot SMTP API:
Once an SMTP API Token is created, it can be used to send emails and track events throughout the HubSpot product. Here are a few ways to use a token once created:
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. |
createdBy | Used in the request JSON | The email address of the user creating the token |
campaignName | Used in the request JSON | A name for the campaign tied to the SMTP API token. Currently used in the List segmentation UI and the SMTP Token API. |
{ "userName": "hrfdvt58el@62515.smtp.hubspot.net", "password": "3432fff8eljl1249fjjasdfnv3", "portalId": 62515, "emailCampaignId": 14862038, "createdAt": 1415660606232, "deleted": false, "createdBy": "maxiak@hubspot.com", "appId": 22709, "campaignName": "test Transactional Email" }
After you send email, use the Email Campaign Data API to retrieve data for the specific token:
https://api.hubapi.com/email/public/v1/campaigns/14862038?appId=22709
After sending email, use the Email Events API to get event data for the specific campaign:
https://api.hubapi.com/email/public/v1/events?campaignId=14862038&appId=22709