Email

Configure Email notifications for your organization.

Get email notification channel

get

Get email notification channel

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Responses

200

Email notification channel

application/json

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

The specified resource was not found

application/json

500

unexpected error

application/json

501

unexpected error

application/json

503

unexpected error

application/json

get

/api/v1/email

HTTPcURLJavaScriptPython

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

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

Create email notification channel

post

Create email notification channel

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Body

application/json

Responses

200

Email notification channel created

application/json

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

The specified resource was not found

application/json

409

The specified resource already exists

application/json

500

unexpected error

application/json

501

unexpected error

application/json

503

unexpected error

application/json

post

/api/v1/email

HTTPcURLJavaScriptPython

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 protected]",
    "password": 123456,
    "smtpHost": "smtp.gmail.com",
    "from": "[email protected]",
    "subject": "My subject"
  }
}

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

Update email notification channel

put

Update email notification channel

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Body

application/json

Responses

200

Email notification channel updated

application/json

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

The specified resource was not found

application/json

500

unexpected error

application/json

501

unexpected error

application/json

503

unexpected error

application/json

put

/api/v1/email

HTTPcURLJavaScriptPython

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 protected]",
    "password": 123456,
    "smtpHost": "smtp.gmail.com",
    "from": "[email protected]",
    "subject": "My subject"
  }
}

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

Delete email notification channel

delete

Delete email notification channel

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Responses

204

Email notification channel deleted

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

The specified resource was not found

application/json

500

unexpected error

application/json

501

unexpected error

application/json

503

unexpected error

application/json

delete

/api/v1/email

HTTPcURLJavaScriptPython

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

bearerAuth

AuthorizationstringRequired

Bearer authentication

Body

application/json

Responses

200

Email notification channel patched

application/json

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

The specified resource was not found

application/json

500

unexpected error

application/json

501

unexpected error

application/json

503

unexpected error

application/json

patch

/api/v1/email

HTTPcURLJavaScriptPython

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 protected]",
    "password": 123456,
    "smtpHost": "smtp.gmail.com",
    "from": "[email protected]",
    "subject": "My subject"
  }
}

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

Get email notification state

get

Get email notification state

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Responses

200

Email Notification state

application/json

enabledboolean · nullableOptional

401

Unauthorized

application/json

403

Forbidden

application/json

404

The specified resource was not found

application/json

500

unexpected error

application/json

501

unexpected error

application/json

503

unexpected error

application/json

get

/api/v1/email/state

HTTPcURLJavaScriptPython

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

bearerAuth

AuthorizationstringRequired

Bearer authentication

Body

application/json

enabledboolean · nullableOptional

Responses

200

Email Notification state

application/json

enabledboolean · nullableOptional

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

The specified resource was not found

application/json

500

unexpected error

application/json

501

unexpected error

application/json

503

unexpected error

application/json

patch

/api/v1/email/state

HTTPcURLJavaScriptPython

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

bearerAuth

AuthorizationstringRequired

Bearer authentication

Body

application/json

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

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

The specified resource was not found

application/json

409

The specified resource already exists

application/json

500

unexpected error

application/json

501

unexpected error

application/json

503

unexpected error

application/json

post

/api/v1/email/validate

HTTPcURLJavaScriptPython

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 protected]",
  "password": 123456,
  "smtpHost": "smtp.gmail.com",
  "from": "[email protected]",
  "subject": "My subject"
}

{
  "status": false,
  "message": "smtp server validation failed"
}