Update an email destination

Selectively update an email destination by DestinationId. A nonempty To array replaces To recipients; null or an empty To array preserves them. For Cc and Bcc, null preserves existing recipients and an empty array clears them. Omitting Cc or Bcc initializes an empty array and can therefore clear recipients. Nonempty Subject, Body, BodyFormat, CustomSenderName and CustomerSenderAddress replace their stored values; null or empty strings preserve them. Omitted BodyFormat defaults to TEXT, so send null to preserve the stored format. Output, naming, enabled and embedding settings are not changed by this operation.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Send application/json or application/x-www-form-urlencoded. Use JSON to represent nested objects, arrays and explicit null values. For form requests, send individual bracketed fields; do not serialize the entire schedule into a field named model. The form example supplies all recipient lists and a format explicitly; the JSON example demonstrates preserving them using null.

int64
required
To
array of strings | null
Defaults to []

Nonempty replaces recipients. Null or empty preserves stored To recipients.

To
Cc
array of strings | null
Defaults to []

Null preserves existing recipients. Empty clears them. Omission defaults to empty and can clear them.

Cc
Bcc
array of strings | null
Defaults to []

Null preserves existing recipients. Empty clears them. Omission defaults to empty and can clear them.

Bcc
string | null
string | null
string | null
enum
Defaults to TEXT

Nonempty changes format; null or empty preserves it. Omission defaults to TEXT.

Allowed:
string | null
string | null

Custom sender email address. The wire spelling is CustomerSenderAddress; this is not a reply-to field.

Headers
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses

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