Retrieve email delivery settings

Retrieves email delivery settings.

SecuritySecretApiKey or JWT
Request
query Parameters
limit
integer [ 0 .. 1000 ]

Limits the number of collection items to be returned.

offset
integer >= 0

Specifies the starting point within the collection of items to be returned.

filter
string

Filters the collection items. This field requires a special format. Use , for multiple allowed values. Use ; for multiple fields.

For more information, see Using filter with collections.

sort
Array of strings

Sorts and orders the collection of items. To sort in descending order, prefix with -.

q
string

Use this field to perform a partial search of text fields.

Responses
200

List of email delivery settings retrieved.

Response Headers
Pagination-Total
integer

Total number of items.

Example: 332
Pagination-Limit
integer

Maximum number of items per page.

Example: 100
Pagination-Offset
integer

Specifies the starting point within the collection of resource results. For example, a request with limit=20 retrieves and displays the first 20 results on a page. A following request with limit=20 and offset=20, retrieves the next page of 20 results.

Example: 2
Response Schema: application/json
Array
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.

get/email-delivery-settings
Request samples
Response samples
application/json
[
  • {
    }
]