Documentation

API reference / Token auth

Senders

Manage from-identities (e.g. support@yourdomain.com) backed by your verified sending domains, including the default sender.

MethodPathDescription
GET/v1/sendersList sender identities (default first).
POST/v1/sendersCreate a sender identity.
POST/v1/senders/{id}/defaultSet a sender as the organization default.
DELETE/v1/senders/{id}Delete a sender identity.

GET /v1/senders

Token + X-MailStack-Org

List sender identities (default first).

Response

[ { "id": "...", "email": "support@yourdomain.com", "displayName": "Support", "isDefault": true } ]

POST /v1/senders

Token + X-MailStack-Org

The email’s domain must be a Verified sending domain of your org. The first sender created becomes the default.

Request body

{ "email": "support@yourdomain.com", "displayName": "Support", "makeDefault": true }

Response

{ "id": "...", "email": "support@yourdomain.com", "displayName": "Support", "isDefault": true }

POST /v1/senders/{id}/default

Token + X-MailStack-Org

Set a sender as the organization default.

Response

{ "id": "...", "isDefault": true }

DELETE /v1/senders/{id}

Token + X-MailStack-Org

Delete a sender identity.

Response

{ "status": "ok" }

SDKs

Prefer a typed client? The Senders endpoints are covered by the official Node, .NET, Go, and Flutter/Dart SDKs.