CustomDomain™ docs
API referenceApplications

How an application's end user notices are sent

How an application's end user notices are sent: reference page for this CustomDomain™ API operation. Covers parameters, request body, responses and error codes.

GET
/applications/{id}/email-sender

Returns the application's email sender setting. With no setting saved the mode is default (the CustomDomain™ transactional sender). The SMTP password is write only: it is never returned, only password_set. Requires app:read.

AuthorizationBearer <token>

Long-lived tenant API key, cd_live_… (production) or cd_test_… (staging, development), stored hashed. Keys created before the switch to cd_ start with sk_live_… / sk_test_… and are still accepted. Scoped to the owning application's tenant.

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/applications/string/email-sender"
{  "application_id": "string",  "mode": "default",  "smtp_host": "string",  "smtp_port": 0,  "smtp_username": "string",  "password_set": true,  "tls": "implicit",  "from_address": "string",  "from_name": "string",  "reply_to": "string",  "verified_at": "2019-08-24T14:15:22Z",  "last_error": "string",  "last_error_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z"}
{  "code": "string",  "title": "string",  "details": "string"}
{  "code": "string",  "title": "string",  "details": "string"}
{  "code": "string",  "title": "string",  "details": "string"}