Update email sender settings

Set the organization's default email sender for the environment of the API key or user session. At least one field is required. Omitted fields keep their saved value, and null clears a field.

The default_from_email domain must be whitelisted for the organization and authenticated for sending. override_template_senders can only be true while default_from_email and default_from_name are set. default_reply_to_email and default_reply_to_name must be set together.

Body Params
string | null

The default "From" email address.

string | null

The default "From" name. One line, with at least one non-space character.

string | null

The default "Reply-To" email address.

string | null

The default "Reply-To" name. One line, with at least one non-space character.

boolean

Whether the defaults are sent instead of every email template's sender. See the email config object.

Responses

400

Validation error, for example an empty body, a malformed email, a "From" domain that is not whitelisted or not authenticated, turning the override on without a default "From" email and name, or a "Reply-To" email without a "Reply-To" name (or a name without an email).

403

The caller is missing the communications:edit permission.

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json