CustomSmtp

Find smtp setting for tenant.

GET

http://localhost:3000/api/smtp/setting

curl -X GET 'http://localhost:3000/api/smtp/setting' \
  -H 'Authorization: Bearer YOUR_TOKEN'

const response = await fetch('http://localhost:3000/api/smtp/setting', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_TOKEN',
  },
});

const data = await response.text();

import requests

response = requests.get(
    'http://localhost:3000/api/smtp/setting',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
    },
)
print(response.text)

200

{
  "deletedAt": "2018-11-21T06:20:32.232Z",
  "createdAt": "2018-11-21T06:20:32.232Z",
  "updatedAt": "2018-11-21T06:20:32.232Z",
  "id": "string",
  "isActive": true,
  "isArchived": false,
  "archivedAt": "2018-11-21T06:20:32.232Z",
  "tenantId": "string",
  "organizationId": "string",
  "fromAddress": "noreply@domain.com",
  "host": "smtp.postmarkapp.com",
  "port": 587,
  "secure": true,
  "isValidate": false
}

Parameters

organizationIdstringquery

Response

200OKCustomSmtp

Found tenant setting

Response fields application/json

deletedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

createdAtstring<date-time>

The creation timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

updatedAtstring<date-time>

The last update timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

idstring

isActivebooleantrue

isArchivedbooleanfalse

archivedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

tenantIdstring

organizationIdstring

fromAddressstringrequired

Example

noreply@domain.com

hoststringrequired

Example

smtp.postmarkapp.com

Example

smtp.gmail.com

portnumberrequired

Example

securebooleanrequired

Example

true

Example

false

isValidatebooleanfalse

401Unauthorized

Unauthorized

403Forbidden

Forbidden

404Not Found

Record not found

Authorization

bearerhttp (bearer) in header

Enter JWT token

Stack Overflow Website Demo