Email

Configure Email notifications for your organization.

Get email notification channel

get

Get email notification channel

Authorizations
AuthorizationstringRequired

Bearer authentication

Responses
chevron-right
200

Email notification channel

application/json
get
/api/v1/email

Create email notification channel

post

Create email notification channel

Authorizations
AuthorizationstringRequired

Bearer authentication

Body
Responses
chevron-right
200

Email notification channel created

application/json
post
/api/v1/email

Update email notification channel

put

Update email notification channel

Authorizations
AuthorizationstringRequired

Bearer authentication

Body
Responses
chevron-right
200

Email notification channel updated

application/json
put
/api/v1/email

Delete email notification channel

delete

Delete email notification channel

Authorizations
AuthorizationstringRequired

Bearer authentication

Responses
delete
/api/v1/email

No content

Patch email notification channel

patch

Patch email notification channel

Authorizations
AuthorizationstringRequired

Bearer authentication

Body
Responses
chevron-right
200

Email notification channel patched

application/json
patch
/api/v1/email

Get email notification state

get

Get email notification state

Authorizations
AuthorizationstringRequired

Bearer authentication

Responses
chevron-right
200

Email Notification state

application/json
enabledboolean · nullableOptional
get
/api/v1/email/state

Update email notification state

patch

Update tenant email notification state

Authorizations
AuthorizationstringRequired

Bearer authentication

Body
enabledboolean · nullableOptional
Responses
chevron-right
200

Email Notification state

application/json
enabledboolean · nullableOptional
patch
/api/v1/email/state

Validate configuration of Email Channel

post

Validate configuration of Email Channel

Authorizations
AuthorizationstringRequired

Bearer authentication

Body
usernamestring · max: 250Optional
passwordstring · max: 250Optional
smtpHoststring · max: 250Required
fromstring · max: 250Optional
smtpPortinteger · max: 65535OptionalDefault: 587
authTypestring · enumOptionalDefault: auth_loginPossible values:
smtpTlsEnabledboolean · nullableOptional
recipientsstring[] · max: 100OptionalDefault: []
fromDisplayNamestring · max: 250OptionalDefault: Run:ai
directNotificationsboolean · nullableOptional
useAttachmentsboolean · nullableOptional
subjectstring · max: 250OptionalDefault: Run:ai notification - {{ .category }} {{ .reason }}
Responses
chevron-right
200

Email Channel validity

application/json
statusbooleanRequired
messagestringOptional
post
/api/v1/email/validate

Last updated