Get the email branding settings for an organization

GET

/v2/organizations/settings/emailBranding

Get the email branding settings applied to outgoing emails sent on behalf of the organization.

Usage notes

To perform this operation, you must use API credentials owned by a user assigned an account type with the Manage email branding permission enabled.
To read or update this setting for a tenant organization, use impersonation to obtain a token for that tenant, then call this endpoint with that token.
signatureName, replyToAddress, and globalBccAddresses can also be updated from the SMTP settings endpoint (GET/PATCH at /v2/organizations/settings/smtp) endpoint. For these fields, the value set most recently from either endpoint is the one used.

Get the email branding settings applied to outgoing emails sent on behalf of the organization. ### Usage notes - To perform this operation, you must use API credentials owned by a user assigned an account type with the **Manage email branding** permission enabled. - To read or update this setting for a tenant organization, use [impersonation](/docs/impersonate-users) to obtain a token for that tenant, then call this endpoint with that token. - `signatureName`, `replyToAddress`, and `globalBccAddresses` can also be updated from the SMTP settings endpoint (`GET`/`PATCH` at `/v2/organizations/settings/smtp`) endpoint. For these fields, the value set most recently from either endpoint is the one used.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Response

The response body.

displayNamestring

Display name shown as the email sender (“From” name) on outgoing branded emails.

signatureNamestring

Name shown in the signature block of outgoing branded emails.

replyToAddressstring or nullformat: "email"

Reply-to email address for outgoing branded emails. null if no reply-to override is configured.

hideSenderInfoboolean

Whether to hide the sender's name and email address on outgoing branded emails.

globalBccAddresseslist of strings

Email addresses that are always bcc'd on outgoing branded emails.

footerBodystring

Footer text appended to outgoing branded emails.