Security

Update SMTP Credential

Update your existing SMTP Credentials. Required Access Level: ModifyAccessTokens

put/security/smtp/{name}

Request

Base URL
https://api.elasticemail.com/v4
URL
https://api.elasticemail.com/v4/security/smtp/{name}
Auth
API key in header X-ElasticEmail-ApiKey

Path parameters

namestring string required

string

Name of the SMTP Credential

Request body

Namestring string required

Name of the Credential for ease of reference. It must be a valid email address.

Expiresstring date-time nullable

Date this SmtpCredential expires.

RestrictAccessToIPRangestring[]

Which IPs can use this SmtpCredential

Subaccountstring string

Email of the subaccount for which this SmtpCredential should be created

Response

OK

AccessLevel'None' | 'ViewAccount' | 'ViewContacts' | 'ViewForms' | 'ViewTemplates' | 'ViewCampaigns' | 'ViewChannels' | 'ViewAutomations' | 'ViewSurveys' | 'ViewSettings' | 'ViewBilling' | 'ViewSubAccounts' | 'ViewUsers' | 'ViewFiles' | 'ViewReports' | 'ModifyAccount' | 'ModifyContacts' | 'ModifyForms' | 'ModifyTemplates' | 'ModifyCampaigns' | 'ModifyChannels' | 'ModifyAutomations' | 'ModifySurveys' | 'ModifyFiles' | 'Export' | 'SendSmtp' | 'SendSMS' | 'ModifySettings' | 'ModifyBilling' | 'ModifyProfile' | 'ModifySubAccounts' | 'ModifyUsers' | 'Security' | 'ModifyLanguage' | 'ViewSupport' | 'SendHttp' | 'Modify2FAEmail' | 'ModifySupport' | 'ViewCustomFields' | 'ModifyCustomFields' | 'ModifyWebNotifications' | 'ExtendedLogs' | 'VerifyEmails' | 'Modify2FASms' | 'ViewVerifyEmails' | 'ViewAccessTokens' | 'ViewWebNotifications' | 'ModifyLandingPages' | 'ViewLandingPages' | 'ModifySuppressions' | 'ViewSuppressions' | 'ViewDragDropEditor' | 'ViewTemplateEditor' | 'ViewAITools' | 'ModifySubscriptionAntiSpam' | 'ViewLandingPagesCheckout' | 'ModifyLandingPagesCheckout' | 'ViewHTMLEditor' | 'ModifyAccessTokens' | 'ViewPaidNewsletters' | 'ModifyPaidNewsletters'

Namestring string

Name of the key.

DateCreatedstring date-time

Date this SmtpCredential was created.

LastUsestring date-time nullable

Date this SmtpCredential was last used.

Expiresstring date-time nullable

Date this SmtpCredential expires.

RestrictAccessToIPRangestring[]

Which IPs can use this SmtpCredential

Changes

No recorded changes to this operation across all 2 revisions of this API.