/
Retrieve email delivery s...

Retrieve email delivery settings

Request

Retrieves email delivery settings.

Security
SecretApiKey or JWT
Query
limitinteger, [ 0 .. 1000 ]

Limits the number of collection items to be returned.

offsetinteger, [ 0 .. 1000 ]

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

filterstring

Criteria for filtering collection items. This field requires a special format. Use , to specify multiple allowed values. Use ; to specify multiple fields.

For more information, see Search filters.

sortArray of strings

Sorts and orders the collection of items. To sort in descending order, prefix with -. Multiple fields can be sorted by separating each with ,.

qstring

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

curl -i -X GET \
  'https://www.rebilly.com/_mock/catalog/all/email-delivery-settings?limit=1000&offset=1000&filter=string&sort=string&q=string' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'

Responses

List of email delivery settings retrieved.

Headers
Pagination-Totalinteger

Total number of items.

Example:332
Pagination-Limitinteger

Maximum number of items per page.

Example:100
Pagination-Offsetinteger

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
Bodyapplication/json
Array [
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": [ … ]
  }
]