Organizations

Update the email branding settings for an organization

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

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.

patch/v2/organizations/settings/emailBranding

Request

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 email nullable

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.

globalBccAddressesstring[]

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

footerBodystring

Footer text appended to outgoing branded emails.

The response body.

displayNamestring required

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

signatureNamestring required

Name shown in the signature block of outgoing branded emails.

replyToAddressstring email nullable required

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

hideSenderInfoboolean required

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

globalBccAddressesstring[] required

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

footerBodystring required

Footer text appended to outgoing branded emails.

No recorded changes to this operation across all 1 revision of this API.