post

/settings/domain

This endpoint enables you to add domains and provides you with corresponding DNS records in the response text.

What is a ‘Sending Domain’? And why it’s required?

A Sending Domain is a domain that is used to indicate who has sent the email, in the “From:” header. Eg. when you sign up with Pepipost, you receive a confirmation mail. This mail is sent from alerts@pepipost.com. Here “pepipost.com” is the sending domain used by us.

To start sending emails to your customers, you can use either your top-level domain eg. mycompany.com or you can use a sub-domain like email.mycompany.com.

For maximum deliverability, we recommend- in fact we have made it mandatory to configure SPF and DKIM records for your sending domain.

Once you have added the sender domain, you need to verify and authenticate the same by adding SPF and DKIM records under domain settings in your Pepipost account. Post that Pepipost compliance team will review the domain. You will be ready to send emails, once the sender domain is approved by the team.

What is an Envelope name? And why it’s required?

Envelope name is the subdomain pointed to our tracking domain. Tracking domain captures the activities observed over your emails. Activities like open, click and unsubscribe are collected over the envelope name. E.g. recipient activities over emails, sent by sending domain ‘pepipost.com’, are tracked using ‘delivery.pepipost.com’ with the envelope name as ‘delivery’.

Request Parameters

1 Header

Request Body

Schema
object
domainName
string

The domain which you want to get white-labelled for sending an email. e.g. mydomain.com

1 validation + required
envelopeName
string

The subdomain which you want to get white-labelled for tracking activities over delivered emails. e.g. mysubdomain.mydomain.com

required

Responses

1 Example
Schema
object
data
object
status
string

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
$$.env
No $$.env variables are being used in this request.