Skip to main content
POST

Authorizations

string | header
required
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

Sender data for creating a new authenticated sender. The email domain must match a verified domain on the project.
string
required
Email address for the sender. The domain portion must match a verified domain on the project.Must be a valid email address.Example: "[email protected]"
string
Display name for the sender (max 200 characters). Shown as the “from” name in recipients’ email clients.Maximum length: 200Example: "Example Team"
string
Reply-to email address. When recipients reply to emails from this sender, replies go to this address.Must be a valid email address.Example: "[email protected]"

Response

Sender created successfully
boolean
Indicates if the request was successfulExample: true
object
string
Confirmation messageExample: "Authenticated sender added successfully"

Error Responses

object
Returned when the sender’s email domain does not match any verified domain on the project.
object
Returned when a sender with the same email already exists on the project.