Create a SMTP API token.

curl --request POST \ --url https://api.hubapi.com/marketing/v3/transactional/smtp-tokens \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "campaignName": "<string>", "createContact": true } '

{ "campaignName": "<string>", "createContact": true, "createdAt": "2023-11-07T05:31:56Z", "createdBy": "<string>", "emailCampaignId": "<string>", "id": "<string>", "password": "<string>" }

Supported products

Required Scopes

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json

A request object to create a SMTP API token

campaignName

string

required

A name for the campaign tied to the SMTP API token.

createContact

boolean

required

Indicates whether a contact should be created for email recipients.

Response

successful operation

A SMTP API token provides both an ID and password that can be used to send email through the HubSpot SMTP API.

campaignName

string

required

A name for the campaign tied to the token.

createContact

boolean

required

Indicates whether a contact should be created for email recipients.

createdAt

string<date-time>

required

Timestamp generated when a token is created.

createdBy

string

required

Email address of the user that sent the token creation request.

emailCampaignId

string

required

Identifier assigned to the campaign provided in the token creation request.

string

required

User name to log into the HubSpot SMTP server.

password

string

Password used to log into the HubSpot SMTP server.