The workspace's saved From addresses, the default first, then by name, so an integration or agent picks a From that can send rather than guessing one. domainVerified says whether the email can send today; a domain that lost verification leaves its senders listed but false. from is the string an email's from takes. Senders are added and changed in the dashboard.
Header parameters
Kirora-Workspacestringoptional
Partner keys only: the child workspace to act in, by the external id the partner gave it. Without it, a partner key acts in its own workspace. Any other key that sends it is refused with 403, and an unknown workspace is 404.
pattern ^[A-Za-z0-9._:-]{1,128}$
Returns
Returns 200 OK with a list of Sender objects in data. Otherwise returns an error; Errors lists every code and which to retry.
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
We'd like to use Google Analytics cookies to understand how people use this site. You can accept or decline them. See our Cookie Policy.