API Reference
  1. peakmuv API
  2. Settings

Update SMTP settings

put
https://peakmuv.com/api/settings/smtp

Configures the outgoing mail transport. Set smtp_provider to peakmuv to use the platform's shared SMTP, or custom to supply your own credentials. When using custom, all host/port/username/password fields become required.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
enum
required

Use peakmuv for the built-in mailer or custom to configure your own SMTP server.

Allowed:
string

Required when smtp_provider is custom. e.g. smtp.gmail.com, smtp.sendgrid.net

integer

Required when smtp_provider is custom. Common ports: 25, 465 (SSL), 587 (TLS).

string

Required when smtp_provider is custom. Usually the sender email address.

password

Required when smtp_provider is custom. SMTP password or app-specific password.

string
enum

Encryption protocol. Use tls for port 587, ssl for port 465, or leave empty for none.

Allowed:
string

The sender display name shown in recipients' inboxes.

string

The From address for outgoing emails. Must be authorised on your SMTP server.

Responses

Updated 2 months ago

Did this page help you?
Language
Credentials
Bearer
sk_live_...
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 2 months ago

Did this page help you?