Email delivery settings

Use email delivery settings to configure from which email address notifications and broadcast message are sent. In Rebilly, this email address is referred to as a "From address". Supported email service providers are: SMTP, Mailgun, SendGrid, AWS SES, Postmark, and Rebilly.

Operations

Verify an email delivery setting

Request

Verifies an email delivery setting.

Security
SecretApiKey or JWT
Path
tokenstringrequired

Token string.

curl -i -X PUT \
  'https://www.rebilly.com/_mock/catalog/all/email-delivery-setting-verifications/{token}' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'

Responses

Email delivery setting verified.

Headers
X-RateLimit-Limitinteger

Total number of rate limit tokens for this request within a rate limit period. For more information, see Rate limits.

Example:3600
X-RateLimit-Remaininginteger

Remaining number of rate limit tokens for this request within the rate limit period. For example, in the sandbox environment, rate limits for non-GET endpoints are set at 3000 requests per 10 minutes.

Example:3600
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.

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": [
    { … }
  ]
}