Ctrlk
Contact support
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Email

Configure Email notifications for your organization.

Get email notification channel

get

Get email notification channel

Authorizations
AuthorizationstringRequired

Bearer authentication

Responses
200

Email notification channel

application/json
get/api/v1/email
GET /api/v1/email HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "config": {
    "username": "email@gmail.com",
    "password": 123456,
    "smtpHost": "smtp.gmail.com",
    "from": "email@gmail.com",
    "subject": "My subject"
  }
}

Create email notification channel

post

Create email notification channel

Authorizations
AuthorizationstringRequired

Bearer authentication

Body
Responses
200

Email notification channel created

application/json
post/api/v1/email
POST /api/v1/email HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 135

{
  "config": {
    "username": "email@gmail.com",
    "password": 123456,
    "smtpHost": "smtp.gmail.com",
    "from": "email@gmail.com",
    "subject": "My subject"
  }
}
{
  "config": {
    "username": "email@gmail.com",
    "password": 123456,
    "smtpHost": "smtp.gmail.com",
    "from": "email@gmail.com",
    "subject": "My subject"
  }
}

Update email notification channel

put

Update email notification channel

Authorizations
AuthorizationstringRequired

Bearer authentication

Body
Responses
200

Email notification channel updated

application/json
put/api/v1/email
PUT /api/v1/email HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 135

{
  "config": {
    "username": "email@gmail.com",
    "password": 123456,
    "smtpHost": "smtp.gmail.com",
    "from": "email@gmail.com",
    "subject": "My subject"
  }
}
{
  "config": {
    "username": "email@gmail.com",
    "password": 123456,
    "smtpHost": "smtp.gmail.com",
    "from": "email@gmail.com",
    "subject": "My subject"
  }
}

Delete email notification channel

delete

Delete email notification channel

Authorizations
AuthorizationstringRequired

Bearer authentication

Responses
204

Email notification channel deleted

No content
delete/api/v1/email
DELETE /api/v1/email HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Patch email notification channel

patch

Patch email notification channel

Authorizations
AuthorizationstringRequired

Bearer authentication

Body
Responses
200

Email notification channel patched

application/json
patch/api/v1/email
PATCH /api/v1/email HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 135

{
  "config": {
    "username": "email@gmail.com",
    "password": 123456,
    "smtpHost": "smtp.gmail.com",
    "from": "email@gmail.com",
    "subject": "My subject"
  }
}
{
  "config": {
    "username": "email@gmail.com",
    "password": 123456,
    "smtpHost": "smtp.gmail.com",
    "from": "email@gmail.com",
    "subject": "My subject"
  }
}

Get email notification state

get

Get email notification state

Authorizations
AuthorizationstringRequired

Bearer authentication

Responses
200

Email Notification state

application/json
enabledboolean · nullableOptional
get/api/v1/email/state
GET /api/v1/email/state HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "enabled": true
}

Update email notification state

patch

Update tenant email notification state

Authorizations
AuthorizationstringRequired

Bearer authentication

Body
enabledboolean · nullableOptional
Responses
200

Email Notification state

application/json
enabledboolean · nullableOptional
patch/api/v1/email/state
PATCH /api/v1/email/state HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "enabled": true
}
{
  "enabled": true
}

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
200

Email Channel validity

application/json
statusbooleanRequired
messagestringOptional
post/api/v1/email/validate
POST /api/v1/email/validate HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 124

{
  "username": "email@gmail.com",
  "password": 123456,
  "smtpHost": "smtp.gmail.com",
  "from": "email@gmail.com",
  "subject": "My subject"
}
{
  "status": false,
  "message": "smtp server validation failed"
}
PreviousSlackNextSubscriptions

Last updated