Update an email delivery setting

Request

Updates an email delivery setting with a specified ID.
Security
SecretApiKey or JWT
Path
idstring, <= 50 characters^[@~\-\.\w]+$required
ID of the resource.
Bodyapplication/jsonrequired
Email delivery setting resource.
fromstring, (email), <= 254 charactersrequired

Email address of the sender.

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

Example:"from-example@rebilly.com"
namestringrequired
Name of the sender.
Example:"John Doe"
credentialIdstring or null

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

Example:"b120c2ca-6c2b-4690-9dff-3b0d87852dc7"
isDefaultboolean
Specifies if the email delivery setting is used by default.
Default:false
curl -i -X PATCH \
  'https://www.rebilly.com/_mock/catalog/all/email-delivery-settings/{id}' \
  -H 'Content-Type: application/json' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE' \
  -d '{
    "from": "from-example@rebilly.com",
    "name": "John Doe",
    "credentialId": "b120c2ca-6c2b-4690-9dff-3b0d87852dc7",
    "isDefault": false
  }'

Responses

Email delivery setting updated.
Headers
Rate-Limit-Limitinteger

Maximum number of requests available at one time for this rate limit. For more information, see Rate limits.

Example:500
Rate-Limit-Remaininginteger

Number of requests still available for this rate limit. For more information, see Rate limits.

Example:499
Bodyapplication/json
idstring, <= 50 charactersread-only
ID of the email delivery setting.
Example:"mail_dst_0YVCNQV8PSCERAJ7N1V4WWPZN2"
fromstring, (email), <= 254 charactersrequired

Email address of the sender.

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

Example:"from-example@rebilly.com"
namestringrequired
Name of the sender.
Example:"John Doe"
statusstringread-only
Status of the email message.
Enum:"pending""verified"
credentialIdstring or null

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

Example:"b120c2ca-6c2b-4690-9dff-3b0d87852dc7"
providerstringread-only
Email service provider name.
Enum:"rebilly""smtp""aws-ses""mailgun""postmark""sendgrid"
Example:"rebilly"
isDefaultboolean
Specifies if the email delivery setting is used by default.
Default:false
createdTimestring, (date-time)(CreatedTime)read-only
Date and time when the resource is created. This value is set automatically when the resource is created.
updatedTimestring, (date-time)(UpdatedTime)read-only
Date and time when the resource is updated. This value is set automatically when the resource is updated.
_linksArray of objects(SelfLink)read-only
Related links.
Response
{
  "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": [
    { … }
  ]
}