Email Delivery Settings

Verify an email delivery setting

Verify an email delivery setting.

Request
Security:
path Parameters
token
required
string

The token string.

header Parameters
Organization-Id
string (ResourceId) <= 50 characters
Deprecated

Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).

It is deprecated. Use servers with /organizations/{organizationId} base path instead.

Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21
Responses
200

Email delivery setting was verified successfully.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

404

Resource was not found.

put/email-delivery-setting-verifications/{token}
Request samples
curl -i -X PUT \
  https://api-sandbox.rebilly.com/organizations/unknown/email-delivery-setting-verifications/:token \
  -H 'Organization-Id: 4f6cf35x-2c4y-483z-a0a9-158621f77a21' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'
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"
}

Retrieve a list of email delivery settings

Request
Security:
query Parameters
limit
integer [ 0 .. 1000 ]

The collection items limit.

offset
integer >= 0

The collection items offset.

filter
string

The collection items filter requires a special format. Use "," for multiple allowed values. Use ";" for multiple fields. See the filter guide for more options and examples about this format.

sort
Array of strings

The collection items sort field and order (prefix with "-" for descending sort).

q
string

The partial search of the text fields.

header Parameters
Organization-Id
string (ResourceId) <= 50 characters
Deprecated

Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).

It is deprecated. Use servers with /organizations/{organizationId} base path instead.

Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21
Responses
200

A list of email delivery settings was retrieved successfully.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

get/email-delivery-settings
Request samples
curl -i -X GET \
  'https://api-sandbox.rebilly.com/organizations/unknown/email-delivery-settings?limit=1000&offset=0&filter=string&sort=string&q=string' \
  -H 'Organization-Id: 4f6cf35x-2c4y-483z-a0a9-158621f77a21' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'
Response samples
application/json
[
  • {
    }
]

Create an email delivery setting

Create an email delivery setting. The email delivery setting is used in. conjunction with email messages or templates to send emails.

Request
Security:
header Parameters
Organization-Id
string (ResourceId) <= 50 characters
Deprecated

Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).

It is deprecated. Use servers with /organizations/{organizationId} base path instead.

Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21
Request Body schema: application/json

Email delivery setting resource.

from
required
string <email> <= 254 characters

The sender's email address. It must be unique within your account.

name
required
string

The sender's name.

credentialId
string

SMTP or any Email Service Provider credential identifier string.

isDefault
boolean
Default: false

Whether this setting will be used by default or not.

Responses
201

Email delivery setting was created.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

422

Invalid data was sent.

post/email-delivery-settings
Request samples
application/json
{
  • "from": "from-example@rebilly.com",
  • "name": "John Doe",
  • "credentialId": "b120c2ca-6c2b-4690-9dff-3b0d87852dc7",
  • "isDefault": false
}
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"
}

Retrieve an email delivery setting

Retrieve an email delivery setting.

Request
Security:
path Parameters
id
required
string <= 50 characters ^[@~\-\.\w]+$

The resource identifier string.

header Parameters
Organization-Id
string (ResourceId) <= 50 characters
Deprecated

Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).

It is deprecated. Use servers with /organizations/{organizationId} base path instead.

Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21
Responses
200

Email delivery setting with specified identifier was retrieved successfully.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

404

Resource was not found.

get/email-delivery-settings/{id}
Request samples
curl -i -X GET \
  https://api-sandbox.rebilly.com/organizations/unknown/email-delivery-settings/:id \
  -H 'Organization-Id: 4f6cf35x-2c4y-483z-a0a9-158621f77a21' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'
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"
}

Delete an email delivery setting

Delete an email delivery setting.

Request
Security:
path Parameters
id
required
string <= 50 characters ^[@~\-\.\w]+$

The resource identifier string.

header Parameters
Organization-Id
string (ResourceId) <= 50 characters
Deprecated

Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).

It is deprecated. Use servers with /organizations/{organizationId} base path instead.

Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21
Responses
204

Email delivery setting was deleted.

409

Conflict.

delete/email-delivery-settings/{id}
Request samples
curl -i -X DELETE \
  https://api-sandbox.rebilly.com/organizations/unknown/email-delivery-settings/:id \
  -H 'Organization-Id: 4f6cf35x-2c4y-483z-a0a9-158621f77a21' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "status": 400,
  • "title": "string",
  • "detail": "string",
  • "error": "string"
}

Update an email delivery setting

Update an email delivery setting.

Request
Security:
path Parameters
id
required
string <= 50 characters ^[@~\-\.\w]+$

The resource identifier string.

header Parameters
Organization-Id
string (ResourceId) <= 50 characters
Deprecated

Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).

It is deprecated. Use servers with /organizations/{organizationId} base path instead.

Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21
Request Body schema: application/json

Email delivery setting resource.

from
required
string <email> <= 254 characters

The sender's email address. It must be unique within your account.

name
required
string

The sender's name.

credentialId
string

SMTP or any Email Service Provider credential identifier string.

isDefault
boolean
Default: false

Whether this setting will be used by default or not.

Responses
200

Email delivery setting was updated successfully.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

409

Conflict.

422

Invalid data was sent.

patch/email-delivery-settings/{id}
Request samples
application/json
{
  • "from": "from-example@rebilly.com",
  • "name": "John Doe",
  • "credentialId": "b120c2ca-6c2b-4690-9dff-3b0d87852dc7",
  • "isDefault": false
}
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"
}

Resend verification email for an email delivery setting.

Resend verification email for an email delivery setting.

Request
Security:
path Parameters
id
required
string <= 50 characters ^[@~\-\.\w]+$

The resource identifier string.

header Parameters
Organization-Id
string (ResourceId) <= 50 characters
Deprecated

Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).

It is deprecated. Use servers with /organizations/{organizationId} base path instead.

Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21
Responses
200

Verification email was sent successfully.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

404

Resource was not found.

409

Conflict.

post/email-delivery-settings/{id}/resend-email-verification
Request samples
curl -i -X POST \
  https://api-sandbox.rebilly.com/organizations/unknown/email-delivery-settings/:id/resend-email-verification \
  -H 'Organization-Id: 4f6cf35x-2c4y-483z-a0a9-158621f77a21' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'
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"
}