NInixopus
Notifications

Update SMTP config

Changed on

Update SMTP config.

Auth: Required (bearer token). Scope: Organization-scoped in authenticated context. Side effects: May mutate server state.

put/api/v1/notification/smtp

Request

  • Base URL
    http://:8080
  • URL
    http://:8080/api/v1/notification/smtp
  • Auth
    none declared

Headers

Acceptstring

Request body */*

from_emailstring nullable

Sender email address for outgoing emails

from_namestring nullable

Display name for outgoing emails

hoststring nullable

SMTP server hostname

idstring uuid required

SMTP configuration ID to update

organization_idstring uuid required

Organization this SMTP config belongs to

passwordstring nullable

SMTP authentication password

portinteger nullable

SMTP server port

usernamestring nullable

SMTP authentication username

Example request

{
  "from_email": "noreply@example.com",
  "from_name": "Nixopus",
  "host": "smtp.gmail.com",
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "organization_id": "550e8400-e29b-41d4-a716-446655440000",
  "password": "app-password",
  "port": 587,
  "username": "user@gmail.com"
}

Response

OK

messagestring
statusstring

Changes

  • 09f18af670c4Revision changes
    • breaking

      the request property became required

    • breaking

      the request property became required

    • info

      api tag Notifications added

    • info

      api tag api/v1/notification removed

    • info

      api tag smtp removed

  • 2beb810c5221Revision changes
    • warning

      removed the optional property from the response with the status (media type: application/json)

    • warning

      removed the optional property from the response with the status (media type: application/xml)

    • warning

      removed the optional property from the response with the status (media type: application/json)

    • warning

      removed the optional property from the response with the status (media type: application/xml)

    • warning

      removed the optional property from the response with the status (media type: application/json)

    • warning

      removed the optional property from the response with the status (media type: application/xml)

    • warning

      removed the optional property from the response with the status (media type: application/json)

    • warning

      removed the optional property from the response with the status (media type: application/xml)

    • warning

      removed the optional property from the response with the status (media type: application/json)

    • warning

      removed the optional property from the response with the status (media type: application/xml)

    • warning

      removed the optional property from the response with the status (media type: application/json)

    • warning

      removed the optional property from the response with the status (media type: application/xml)

    • warning

      removed the optional property from the response with the status (media type: application/json)

    • warning

      removed the optional property from the response with the status (media type: application/xml)

    • warning

      removed the optional property from the response with the status (media type: application/json)

    • warning

      removed the optional property from the response with the status (media type: application/xml)

    • warning

      removed the optional property from the response with the status (media type: application/json)

    • warning

      removed the optional property from the response with the status (media type: application/xml)

    • warning

      removed the optional property from the response with the status (media type: application/json)

    • warning

      removed the optional property from the response with the status (media type: application/xml)

    • warning

      removed the optional property from the response with the status (media type: application/json)

    • warning

      removed the optional property from the response with the status (media type: application/xml)

    • warning

      removed the optional property from the response with the status (media type: application/json)

    • warning

      removed the optional property from the response with the status (media type: application/xml)

    • info

      api operation id updateEndpoint2 removed and replaced with updateSMTPConfig

    • info

      added the optional property to the response with the status (media type: application/json)

    • info

      added the optional property to the response with the status (media type: application/xml)

    • info

      added the optional property to the response with the status (media type: application/json)

    • info

      added the optional property to the response with the status (media type: application/xml)

    • info

      added the required property to the response with the status (media type: application/json)

    • info

      added the required property to the response with the status (media type: application/xml)

    • info

      added the required property to the response with the status (media type: application/json)

    • info

      added the required property to the response with the status (media type: application/xml)

    • info

      added the required property to the response with the status (media type: application/json)

    • info

      added the required property to the response with the status (media type: application/xml)

    • info

      added the required property to the response with the status (media type: application/json)

    • info

      added the required property to the response with the status (media type: application/xml)