logo

Update an email delivery setting

Updates an email delivery setting with a specified ID.

SecuritySecretApiKey or JWT
Request
path Parameters
id
required
string <= 50 characters ^[@~\-\.\w]+$

ID of the resource.

Request Body schema: application/json

Email delivery setting resource.

from
required
string <email> <= 254 characters

Email address of the sender.

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

name
required
string

Name of the sender.

credentialId
string

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

isDefault
boolean
Default: false

Specifies if the email delivery setting is used by default.

Responses
200

Email delivery setting updated.

Response Schema: application/json
from
required
string <email> <= 254 characters

Email address of the sender.

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

name
required
string

Name of the sender.

id
string <= 50 characters

ID of the email delivery setting.

status
string

Status of the email message.

Enum: "pending" "verified"
credentialId
string

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

provider
string

Email service provider name.

Enum: "rebilly" "smtp" "aws-ses" "mailgun" "postmark" "sendgrid"
isDefault
boolean
Default: false

Specifies if the email delivery setting is used by default.

createdTime
string <date-time> (CreatedTime)

Date and time which is set automatically when the resource is created.

updatedTime
string <date-time> (UpdatedTime)

Date and time which updates automatically when the resource is updated.

Array of objects (SelfLink)

Related links.

Array
href
string

Link URL.

rel
string

Type of link.

Value: "self"
401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

409

Conflict.

422

Invalid data sent.

patch/email-delivery-settings/{id}
Request samples
application/json
{
  • "from": "from-example@rebilly.com",
  • "name": "John Doe",
  • "credentialId": "b120c2ca-6c2b-4690-9dff-3b0d87852dc7",
  • "isDefault": false
}
Response samples
application/json
{
  • "id": "mail_dst_0YVCNQV8PSCERAJ7N1V4WWPZN2",
  • "from": "from-example@rebilly.com",
  • "name": "John Doe",
  • "status": "pending",
  • "credentialId": "b120c2ca-6c2b-4690-9dff-3b0d87852dc7",
  • "provider": "rebilly",
  • "isDefault": false,
  • "createdTime": "2019-08-24T14:15:22Z",
  • "updatedTime": "2019-08-24T14:15:22Z",
  • "_links": [
    ]
}
➔ Next to Resend email delivery setting verification email