Verify an email delivery setting

Verifies an email delivery setting.

SecuritySecretApiKey or JWT
Request
path Parameters
token
required
string

Token string.

Responses
200

Email delivery setting verified.

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

SMTP or Email Service Provider (ESP) credential ID.

provider
string

Email service provider name.

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

Specifies whether 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 (Self) non-empty

Related resource links.

Array (non-empty)
href
required
string

Link URL.

rel
required
string

Type of link.

Value: "self"
401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

404

Resource not found.

put/email-delivery-setting-verifications/{token}
Request samples
Response samples
application/json
{
  • "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "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": [
    ]
}