# Email

Configure Email notifications for your organization.

## Get email notification channel

> Get email notification channel

```json
{"openapi":"3.0.3","info":{"title":"NVIDIA Run:ai","version":"2.25"},"tags":[{"name":"Email","description":"Configure Email notifications for your organization."}],"servers":[{"url":"https://app.run.ai"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer authentication"}},"schemas":{"EmailChannel":{"type":"object","required":["config"],"properties":{"config":{"$ref":"#/components/schemas/EmailChannelConfig"}}},"EmailChannelConfig":{"type":"object","required":["smtpHost"],"allOf":[{"$ref":"#/components/schemas/EmailNotificationChannelConfig"}]},"EmailNotificationChannelConfig":{"type":"object","properties":{"username":{"type":"string","maxLength":250},"password":{"type":"string","maxLength":250},"smtpHost":{"type":"string","maxLength":250},"from":{"type":"string","maxLength":250},"smtpPort":{"type":"integer","default":587,"maximum":65535},"authType":{"$ref":"#/components/schemas/EmailAuthType"},"smtpTlsEnabled":{"type":"boolean","nullable":true},"recipients":{"type":"array","items":{"type":"string"},"default":[],"minItems":0,"maxItems":100},"fromDisplayName":{"type":"string","default":"Run:ai","maxLength":250},"directNotifications":{"type":"boolean","nullable":true},"useAttachments":{"type":"boolean","nullable":true},"subject":{"type":"string","default":"Run:ai notification - {{ .category }} {{ .reason }}","maxLength":250}}},"EmailAuthType":{"type":"string","enum":["auth_login","auth_plain","auth_none",""],"default":"auth_login"},"Error":{"required":["code","message"],"properties":{"code":{"type":"integer","minimum":100,"maximum":599},"message":{"type":"string"},"details":{"type":"string"}}}},"responses":{"400BadRequest":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404NotFound":{"description":"The specified resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500InternalServerError":{"description":"unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"501NotImplemented":{"description":"unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503ServiceUnavailable":{"description":"unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"paths":{"/api/v1/email":{"get":{"tags":["Email"],"operationId":"getEmail","summary":"Get email notification channel","description":"Get email notification channel","responses":{"200":{"description":"Email notification channel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailChannel"}}}},"400":{"$ref":"#/components/responses/400BadRequest"},"401":{"$ref":"#/components/responses/401Unauthorized"},"403":{"$ref":"#/components/responses/403Forbidden"},"404":{"$ref":"#/components/responses/404NotFound"},"500":{"$ref":"#/components/responses/500InternalServerError"},"501":{"$ref":"#/components/responses/501NotImplemented"},"503":{"$ref":"#/components/responses/503ServiceUnavailable"}}}}}}
```

## Create email notification channel

> Create email notification channel

```json
{"openapi":"3.0.3","info":{"title":"NVIDIA Run:ai","version":"2.25"},"tags":[{"name":"Email","description":"Configure Email notifications for your organization."}],"servers":[{"url":"https://app.run.ai"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer authentication"}},"schemas":{"EmailChannel":{"type":"object","required":["config"],"properties":{"config":{"$ref":"#/components/schemas/EmailChannelConfig"}}},"EmailChannelConfig":{"type":"object","required":["smtpHost"],"allOf":[{"$ref":"#/components/schemas/EmailNotificationChannelConfig"}]},"EmailNotificationChannelConfig":{"type":"object","properties":{"username":{"type":"string","maxLength":250},"password":{"type":"string","maxLength":250},"smtpHost":{"type":"string","maxLength":250},"from":{"type":"string","maxLength":250},"smtpPort":{"type":"integer","default":587,"maximum":65535},"authType":{"$ref":"#/components/schemas/EmailAuthType"},"smtpTlsEnabled":{"type":"boolean","nullable":true},"recipients":{"type":"array","items":{"type":"string"},"default":[],"minItems":0,"maxItems":100},"fromDisplayName":{"type":"string","default":"Run:ai","maxLength":250},"directNotifications":{"type":"boolean","nullable":true},"useAttachments":{"type":"boolean","nullable":true},"subject":{"type":"string","default":"Run:ai notification - {{ .category }} {{ .reason }}","maxLength":250}}},"EmailAuthType":{"type":"string","enum":["auth_login","auth_plain","auth_none",""],"default":"auth_login"},"Error":{"required":["code","message"],"properties":{"code":{"type":"integer","minimum":100,"maximum":599},"message":{"type":"string"},"details":{"type":"string"}}}},"responses":{"400BadRequest":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404NotFound":{"description":"The specified resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409Conflict":{"description":"The specified resource already exists","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500InternalServerError":{"description":"unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"501NotImplemented":{"description":"unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503ServiceUnavailable":{"description":"unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"paths":{"/api/v1/email":{"post":{"tags":["Email"],"operationId":"createEmail","summary":"Create email notification channel","description":"Create email notification channel","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailChannel"}}}},"responses":{"200":{"description":"Email notification channel created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailChannel"}}}},"400":{"$ref":"#/components/responses/400BadRequest"},"401":{"$ref":"#/components/responses/401Unauthorized"},"403":{"$ref":"#/components/responses/403Forbidden"},"404":{"$ref":"#/components/responses/404NotFound"},"409":{"$ref":"#/components/responses/409Conflict"},"500":{"$ref":"#/components/responses/500InternalServerError"},"501":{"$ref":"#/components/responses/501NotImplemented"},"503":{"$ref":"#/components/responses/503ServiceUnavailable"}}}}}}
```

## Update email notification channel

> Update email notification channel

```json
{"openapi":"3.0.3","info":{"title":"NVIDIA Run:ai","version":"2.25"},"tags":[{"name":"Email","description":"Configure Email notifications for your organization."}],"servers":[{"url":"https://app.run.ai"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer authentication"}},"schemas":{"EmailChannel":{"type":"object","required":["config"],"properties":{"config":{"$ref":"#/components/schemas/EmailChannelConfig"}}},"EmailChannelConfig":{"type":"object","required":["smtpHost"],"allOf":[{"$ref":"#/components/schemas/EmailNotificationChannelConfig"}]},"EmailNotificationChannelConfig":{"type":"object","properties":{"username":{"type":"string","maxLength":250},"password":{"type":"string","maxLength":250},"smtpHost":{"type":"string","maxLength":250},"from":{"type":"string","maxLength":250},"smtpPort":{"type":"integer","default":587,"maximum":65535},"authType":{"$ref":"#/components/schemas/EmailAuthType"},"smtpTlsEnabled":{"type":"boolean","nullable":true},"recipients":{"type":"array","items":{"type":"string"},"default":[],"minItems":0,"maxItems":100},"fromDisplayName":{"type":"string","default":"Run:ai","maxLength":250},"directNotifications":{"type":"boolean","nullable":true},"useAttachments":{"type":"boolean","nullable":true},"subject":{"type":"string","default":"Run:ai notification - {{ .category }} {{ .reason }}","maxLength":250}}},"EmailAuthType":{"type":"string","enum":["auth_login","auth_plain","auth_none",""],"default":"auth_login"},"Error":{"required":["code","message"],"properties":{"code":{"type":"integer","minimum":100,"maximum":599},"message":{"type":"string"},"details":{"type":"string"}}}},"responses":{"400BadRequest":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404NotFound":{"description":"The specified resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500InternalServerError":{"description":"unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"501NotImplemented":{"description":"unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503ServiceUnavailable":{"description":"unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"paths":{"/api/v1/email":{"put":{"tags":["Email"],"operationId":"updateEmail","summary":"Update email notification channel","description":"Update email notification channel","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailChannel"}}}},"responses":{"200":{"description":"Email notification channel updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailChannel"}}}},"400":{"$ref":"#/components/responses/400BadRequest"},"401":{"$ref":"#/components/responses/401Unauthorized"},"403":{"$ref":"#/components/responses/403Forbidden"},"404":{"$ref":"#/components/responses/404NotFound"},"500":{"$ref":"#/components/responses/500InternalServerError"},"501":{"$ref":"#/components/responses/501NotImplemented"},"503":{"$ref":"#/components/responses/503ServiceUnavailable"}}}}}}
```

## Delete email notification channel

> Delete email notification channel

```json
{"openapi":"3.0.3","info":{"title":"NVIDIA Run:ai","version":"2.25"},"tags":[{"name":"Email","description":"Configure Email notifications for your organization."}],"servers":[{"url":"https://app.run.ai"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer authentication"}},"responses":{"400BadRequest":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404NotFound":{"description":"The specified resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500InternalServerError":{"description":"unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"501NotImplemented":{"description":"unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503ServiceUnavailable":{"description":"unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"schemas":{"Error":{"required":["code","message"],"properties":{"code":{"type":"integer","minimum":100,"maximum":599},"message":{"type":"string"},"details":{"type":"string"}}}}},"paths":{"/api/v1/email":{"delete":{"tags":["Email"],"operationId":"deleteEmail","summary":"Delete email notification channel","description":"Delete email notification channel","responses":{"204":{"description":"Email notification channel deleted"},"400":{"$ref":"#/components/responses/400BadRequest"},"401":{"$ref":"#/components/responses/401Unauthorized"},"403":{"$ref":"#/components/responses/403Forbidden"},"404":{"$ref":"#/components/responses/404NotFound"},"500":{"$ref":"#/components/responses/500InternalServerError"},"501":{"$ref":"#/components/responses/501NotImplemented"},"503":{"$ref":"#/components/responses/503ServiceUnavailable"}}}}}}
```

## Patch email notification channel

> Patch email notification channel

```json
{"openapi":"3.0.3","info":{"title":"NVIDIA Run:ai","version":"2.25"},"tags":[{"name":"Email","description":"Configure Email notifications for your organization."}],"servers":[{"url":"https://app.run.ai"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer authentication"}},"schemas":{"EmailChannelForPatch":{"type":"object","required":["config"],"properties":{"config":{"$ref":"#/components/schemas/EmailChannelConfigForPatch"}}},"EmailChannelConfigForPatch":{"type":"object","allOf":[{"$ref":"#/components/schemas/EmailNotificationChannelConfig"}]},"EmailNotificationChannelConfig":{"type":"object","properties":{"username":{"type":"string","maxLength":250},"password":{"type":"string","maxLength":250},"smtpHost":{"type":"string","maxLength":250},"from":{"type":"string","maxLength":250},"smtpPort":{"type":"integer","default":587,"maximum":65535},"authType":{"$ref":"#/components/schemas/EmailAuthType"},"smtpTlsEnabled":{"type":"boolean","nullable":true},"recipients":{"type":"array","items":{"type":"string"},"default":[],"minItems":0,"maxItems":100},"fromDisplayName":{"type":"string","default":"Run:ai","maxLength":250},"directNotifications":{"type":"boolean","nullable":true},"useAttachments":{"type":"boolean","nullable":true},"subject":{"type":"string","default":"Run:ai notification - {{ .category }} {{ .reason }}","maxLength":250}}},"EmailAuthType":{"type":"string","enum":["auth_login","auth_plain","auth_none",""],"default":"auth_login"},"EmailChannel":{"type":"object","required":["config"],"properties":{"config":{"$ref":"#/components/schemas/EmailChannelConfig"}}},"EmailChannelConfig":{"type":"object","required":["smtpHost"],"allOf":[{"$ref":"#/components/schemas/EmailNotificationChannelConfig"}]},"Error":{"required":["code","message"],"properties":{"code":{"type":"integer","minimum":100,"maximum":599},"message":{"type":"string"},"details":{"type":"string"}}}},"responses":{"400BadRequest":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404NotFound":{"description":"The specified resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500InternalServerError":{"description":"unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"501NotImplemented":{"description":"unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503ServiceUnavailable":{"description":"unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"paths":{"/api/v1/email":{"patch":{"tags":["Email"],"operationId":"patchEmail","summary":"Patch email notification channel","description":"Patch email notification channel","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailChannelForPatch"}}}},"responses":{"200":{"description":"Email notification channel patched","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailChannel"}}}},"400":{"$ref":"#/components/responses/400BadRequest"},"401":{"$ref":"#/components/responses/401Unauthorized"},"403":{"$ref":"#/components/responses/403Forbidden"},"404":{"$ref":"#/components/responses/404NotFound"},"500":{"$ref":"#/components/responses/500InternalServerError"},"501":{"$ref":"#/components/responses/501NotImplemented"},"503":{"$ref":"#/components/responses/503ServiceUnavailable"}}}}}}
```

## Get email notification state

> Get email notification state

```json
{"openapi":"3.0.3","info":{"title":"NVIDIA Run:ai","version":"2.25"},"tags":[{"name":"Email","description":"Configure Email notifications for your organization."}],"servers":[{"url":"https://app.run.ai"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer authentication"}},"schemas":{"NotificationStateStatus":{"type":"object","properties":{"enabled":{"type":"boolean","nullable":true}}},"Error":{"required":["code","message"],"properties":{"code":{"type":"integer","minimum":100,"maximum":599},"message":{"type":"string"},"details":{"type":"string"}}}},"responses":{"401Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404NotFound":{"description":"The specified resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500InternalServerError":{"description":"unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"501NotImplemented":{"description":"unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503ServiceUnavailable":{"description":"unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"paths":{"/api/v1/email/state":{"get":{"tags":["Email"],"operationId":"getEmailNotificationState","summary":"Get email notification state","description":"Get email notification state","responses":{"200":{"description":"Email Notification state","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotificationStateStatus"}}}},"401":{"$ref":"#/components/responses/401Unauthorized"},"403":{"$ref":"#/components/responses/403Forbidden"},"404":{"$ref":"#/components/responses/404NotFound"},"500":{"$ref":"#/components/responses/500InternalServerError"},"501":{"$ref":"#/components/responses/501NotImplemented"},"503":{"$ref":"#/components/responses/503ServiceUnavailable"}}}}}}
```

## Update email notification state

> Update tenant email notification state

```json
{"openapi":"3.0.3","info":{"title":"NVIDIA Run:ai","version":"2.25"},"tags":[{"name":"Email","description":"Configure Email notifications for your organization."}],"servers":[{"url":"https://app.run.ai"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer authentication"}},"schemas":{"NotificationStateStatus":{"type":"object","properties":{"enabled":{"type":"boolean","nullable":true}}},"Error":{"required":["code","message"],"properties":{"code":{"type":"integer","minimum":100,"maximum":599},"message":{"type":"string"},"details":{"type":"string"}}}},"responses":{"400BadRequest":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404NotFound":{"description":"The specified resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500InternalServerError":{"description":"unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"501NotImplemented":{"description":"unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503ServiceUnavailable":{"description":"unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"paths":{"/api/v1/email/state":{"patch":{"tags":["Email"],"operationId":"updateEmailNotificationState","summary":"Update email notification state","description":"Update tenant email notification state","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotificationStateStatus"}}}},"responses":{"200":{"description":"Email Notification state","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotificationStateStatus"}}}},"400":{"$ref":"#/components/responses/400BadRequest"},"401":{"$ref":"#/components/responses/401Unauthorized"},"403":{"$ref":"#/components/responses/403Forbidden"},"404":{"$ref":"#/components/responses/404NotFound"},"500":{"$ref":"#/components/responses/500InternalServerError"},"501":{"$ref":"#/components/responses/501NotImplemented"},"503":{"$ref":"#/components/responses/503ServiceUnavailable"}}}}}}
```

## Validate configuration of Email Channel

> Validate configuration of Email Channel

```json
{"openapi":"3.0.3","info":{"title":"NVIDIA Run:ai","version":"2.25"},"tags":[{"name":"Email","description":"Configure Email notifications for your organization."}],"servers":[{"url":"https://app.run.ai"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer authentication"}},"schemas":{"EmailChannelConfig":{"type":"object","required":["smtpHost"],"allOf":[{"$ref":"#/components/schemas/EmailNotificationChannelConfig"}]},"EmailNotificationChannelConfig":{"type":"object","properties":{"username":{"type":"string","maxLength":250},"password":{"type":"string","maxLength":250},"smtpHost":{"type":"string","maxLength":250},"from":{"type":"string","maxLength":250},"smtpPort":{"type":"integer","default":587,"maximum":65535},"authType":{"$ref":"#/components/schemas/EmailAuthType"},"smtpTlsEnabled":{"type":"boolean","nullable":true},"recipients":{"type":"array","items":{"type":"string"},"default":[],"minItems":0,"maxItems":100},"fromDisplayName":{"type":"string","default":"Run:ai","maxLength":250},"directNotifications":{"type":"boolean","nullable":true},"useAttachments":{"type":"boolean","nullable":true},"subject":{"type":"string","default":"Run:ai notification - {{ .category }} {{ .reason }}","maxLength":250}}},"EmailAuthType":{"type":"string","enum":["auth_login","auth_plain","auth_none",""],"default":"auth_login"},"ValidateSinkResponse":{"type":"object","properties":{"status":{"type":"boolean"},"message":{"type":"string"}},"required":["status"]},"Error":{"required":["code","message"],"properties":{"code":{"type":"integer","minimum":100,"maximum":599},"message":{"type":"string"},"details":{"type":"string"}}}},"responses":{"400BadRequest":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404NotFound":{"description":"The specified resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409Conflict":{"description":"The specified resource already exists","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500InternalServerError":{"description":"unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"501NotImplemented":{"description":"unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503ServiceUnavailable":{"description":"unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"paths":{"/api/v1/email/validate":{"post":{"tags":["Email"],"operationId":"validateEmail","summary":"Validate configuration of Email Channel","description":"Validate configuration of Email Channel","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailChannelConfig"}}}},"responses":{"200":{"description":"Email Channel validity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidateSinkResponse"}}}},"400":{"$ref":"#/components/responses/400BadRequest"},"401":{"$ref":"#/components/responses/401Unauthorized"},"403":{"$ref":"#/components/responses/403Forbidden"},"404":{"$ref":"#/components/responses/404NotFound"},"409":{"$ref":"#/components/responses/409Conflict"},"500":{"$ref":"#/components/responses/500InternalServerError"},"501":{"$ref":"#/components/responses/501NotImplemented"},"503":{"$ref":"#/components/responses/503ServiceUnavailable"}}}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://run-ai-docs.nvidia.com/api/2.25/notifications/email.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.