PATCH /email-delivery-settings/{id}

Updates an email delivery setting with a specified ID.

Servers

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
id String No

ID of the email delivery setting.

_links[] Array No

Related links.

_links[].href String No

Link URL.

_links[].rel String No

Type of link.

Valid values:

  • "self"
provider String No

Email service provider name.

Valid values:

  • "rebilly"
  • "postmark"
  • "smtp"
  • "aws-ses"
  • "mailgun"
  • "sendgrid"
name String Yes

Name of the sender.

updatedTime String No

Date and time when the resource is updated. This value is set automatically when the resource is updated.

createdTime String No

Date and time when the resource is created. This value is set automatically when the resource is created.

isDefault Boolean No

Specifies if the email delivery setting is used by default.

Default value: false

status String No

Status of the email message.

Valid values:

  • "pending"
  • "verified"
credentialId String No

ID of the SMTP or Email Service Provider (ESP) credential.

from String Yes

Email address of the sender.

Important: This email address must be unique within your account.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.