logo

Create an email credential

Creates an email credential.

SecuritySecretApiKey or JWT
Request
Request Body schema: application/json

SMTP credential resource.

host
required
string

SMTP host name.

status
string

Status of the credential.

Enum: Description
active

Credential is active and can be used.

inactive

Credential is temporarily inactivated and cannot be used until reactivated.

deactivated

Credential is permanently deactivated and cannot be reactivated.

port
integer [ 1 .. 65535 ]
Default: 25

SMTP port value.

encryption
string
Default: "none"

Encryption value.

Enum: "none" "tls" "ssl"
object (SmtpAuthorization)

Authentication type and details.

type
string
Default: "none"
Responses
201

SMTP credential created.

Response Headers
Location
string <uri>

Location of the related resource.

Example: "https://api.rebilly.com/example"
Response Schema: application/json
host
required
string

SMTP host name.

hash
string <= 50 characters

Unique resource ID. Defaults to UUID v4.

status
string

Status of the credential.

Enum: Description
active

Credential is active and can be used.

inactive

Credential is temporarily inactivated and cannot be used until reactivated.

deactivated

Credential is permanently deactivated and cannot be reactivated.

deactivationTime
string <date-time>

Date and time when the credential is deactivated.

port
integer [ 1 .. 65535 ]
Default: 25

SMTP port value.

encryption
string
Default: "none"

Encryption value.

Enum: "none" "tls" "ssl"
object (SmtpAuthorization)

Authentication type and details.

type
string
Default: "none"
Array of objects (SelfLink)

Related links.

Array
href
string

Link URL.

rel
string

Type of link.

Value: "self"
303

Existing SMTP credential retrieved.

401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

422

Invalid data sent.

post/credential-hashes/emails
Request samples
application/json
{
  • "status": "active",
  • "host": "string",
  • "port": 25,
  • "encryption": "none",
  • "auth": {
    }
}
Response samples
application/json
{
  • "hash": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "status": "active",
  • "deactivationTime": "2019-08-24T14:15:22Z",
  • "host": "string",
  • "port": 25,
  • "encryption": "none",
  • "auth": {
    },
  • "_links": [
    ]
}
➔ Next to Retrieve an email credential