Skip to navigation
EmailSender

Get sender

Retrieves the sender (mailing output) linked to the authenticated API Key. Only public data is returned; the connection credentials are never exposed. Responds 400 with errorCode 569 if the output is no longer available for the account.

Authentication

x-api-keystring

Account authentication key. The App-Key must have the Email channel enabled and a sender (mailing output) linked; it cannot be used against the endpoints of other channels.

OR
AuthorizationBearer

OAuth 2.0 access token issued by POST /api/oauth/token (client-credentials). Takes precedence over x-api-key when both are sent. See the Authentication section.

Response

Sender of the App-Key.

_idstringOptional

Id of the sender (mailing output).

namestringOptional
providerstringOptional
Email provider of the output.
from_namestring or nullOptional
Display name shown to the recipient.
from_emailstring or nullOptional
Address the emails are sent from.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
429
Too Many Requests Error