Docs
kirora.ioGet started
Senders overviewMenu
On this page

API reference

Senders

A sender is a From address the workspace has saved, on one of its sending domains, with one default that new emails start with. List them to pick a From that can send; they are added and changed in the dashboard.

Endpoints

EndpointRequest
List sendersGET /v1/senders

The Sender object

Sender example
{
  "id": "018f2a4e-6b1c-7d3e-9f40-37386ae05a6b",
  "name": "name_example",
  "email": "email_example",
  "replyTo": "replyTo_example",
  "isDefault": true,
  "sendingDomainId": "018f2a4e-6b1c-7d3e-9f40-adeafec05a6b",
  "domainVerified": true,
  "from": "from_example",
  "createdAt": "2030-03-14T09:30:00Z"
}
idstringrequired

uuid

namestringrequired

The display name the inbox shows.

emailstringrequired
replyTostring | nullrequired
isDefaultbooleanrequired

Whether new emails start with this sender; at most one is.

sendingDomainIdstring | nullrequired

The verified sending domain the email is on; null while it can't send.

uuid

domainVerifiedbooleanrequired

Whether the email's domain is verified and can send now.

fromstringrequired

"Name <email>", the string an email's from takes.

createdAtstringrequired

date-time