Skip to content

Get email settings

GET
/settings/email

Returns the effective email provider, the site's outbound email address, and the list of available providers.

Authorizations

bearerToken|siteContext
bearerToken

Personal access token tied to a user account. Requires the X-Nimbu-Site header to scope requests.

TypeHTTP (bearer)
+
siteContext

Identifier of the site context when authenticating with a personal access token.

TypeAPI Key (header: X-Nimbu-Site)
or
siteToken

Site-scoped API token that already encodes the site context.

TypeHTTP (bearer)

Responses

email settings returned

application/json
JSON
{
"email_provider": "string",
"site_email": "string",
"available_providers": [
"string"
]
}

Playground

Authorization

Samples

Part of Nimbu, built by Zenjoy.